dispel.providers.generic.tasks.gait.steps module#

Six-Minute Walk test related functionality.

This module contains functionality to extract measures for the Six-minute Walk test (6MWT).

class dispel.providers.generic.tasks.gait.steps.BehavioralDeviations[source]#

Bases: ProcessingStepGroup

Behavioral deviation steps.

steps: List[ProcessingStep] = [<dispel.providers.generic.flags.le_flags.NonBeltDetected6MWT object>, <dispel.providers.generic.flags.le_flags.NoMovementDetected object>, <dispel.providers.generic.flags.le_flags.ExcessiveTurns object>, <dispel.providers.generic.flags.le_flags.NotEnoughRectilinearWalkingOnBeltDetected object>]#

class dispel.providers.generic.tasks.gait.steps.BehavioralInvalidations[source]#

Bases: ProcessingStepGroup

Behavioral invalidation steps.

steps: List[ProcessingStep] = [<dispel.providers.generic.flags.le_flags.NonBeltDetected6MWT object>, <dispel.providers.generic.flags.le_flags.NoMovementDetected object>, <dispel.providers.generic.flags.le_flags.ExcessiveTurns object>, <dispel.providers.generic.flags.le_flags.NotEnoughRectilinearWalkingOnBeltDetected object>]#

class dispel.providers.generic.tasks.gait.steps.CWTMeasureSteps[source]#

Bases: ProcessingStepGroup

CWT measure extraction steps.

steps: List[ProcessingStep] = [<dispel.providers.generic.tasks.gait.cwt.CWTMeasures object>, <dispel.providers.generic.tasks.gait.cwt.CWTMeasures object>, <dispel.providers.generic.tasks.gait.cwt.CWTMeasures object>, <dispel.providers.generic.tasks.gait.cwt.CWTMeasuresWithoutBout object>]#

class dispel.providers.generic.tasks.gait.steps.CWTSteps[source]#

Bases: ProcessingStepGroup

CWT transformation steps.

steps: List[ProcessingStep] = [<dispel.providers.generic.tasks.gait.cwt.FormatAccelerationCWT object>, <dispel.providers.generic.tasks.gait.cwt.CWTDetectStepsWithoutBout object>, <dispel.providers.generic.tasks.gait.cwt.CWTDetectSteps object>, <dispel.providers.generic.tasks.gait.cwt.OptimizeCwtStepDatasetWithoutWalkingBout object>, <dispel.providers.generic.tasks.gait.cwt.OptimizeCwtStepDataset object>, <dispel.providers.generic.tasks.gait.cwt.HeightChangeCOM object>, <dispel.providers.generic.tasks.gait.cwt.HeightChangeCOM object>, <dispel.providers.generic.sensor.EuclideanNorm object>, <dispel.providers.generic.preprocessing.Detrend object>, <dispel.providers.generic.tasks.gait.core.TransformStepVigorWithoutBout object>, <dispel.providers.generic.tasks.gait.core.TransformStepVigor object>, <dispel.providers.generic.tasks.gait.core.TransformGaitRegularityWithoutBout object>, <dispel.providers.generic.tasks.gait.core.TransformGaitRegularity object>, <dispel.providers.generic.tasks.gait.cwt.CWTMeasureWithoutBoutTransformation object>, <dispel.providers.generic.tasks.gait.cwt.CWTMeasureTransformation object>]#

class dispel.providers.generic.tasks.gait.steps.ComputeDistanceAndSpeed[source]#

Bases: TransformStep

A raw data set transformation step to get user’s distance and speed.

When calculating the speed, we have chosen to ignore stoppage time.For more information, see the TransformStep.

data_set_ids: str | Iterable[str] = 'gps'#: An iterable of data sets to be being processed

definitions: List[RawDataValueDefinition] = [<RawDataValueDefinition: distance (calculated distance, float64)>, <RawDataValueDefinition: speed (calculated speed, float64)>]#

new_data_set_id: str = 'distance_and_speed'#

class dispel.providers.generic.tasks.gait.steps.ComputeDistanceInertial[source]#

Bases: LevelProcessingStep, MeasureDefinitionMixin

Compute distance from step count and step length.

definition: ValueDefinition | ValueDefinitionPrototype | None = <dispel.data.measures.MeasureValueDefinitionPrototype object>#: The specification of the measure definition

process_level(level, reading, **kwargs)[source]#

Process level to extract the distance walk.

Parameters:

level (Level) –
reading (Reading) –

Return type:

Generator[ProcessingResult | ProcessingControlResult, None, None]

class dispel.providers.generic.tasks.gait.steps.FlagPreprocessing[source]#

Bases: ProcessingStepGroup

Preprocessing required for flags.

steps: List[ProcessingStep] = [<dispel.providers.generic.flags.le_flags.PercentageNotWalking object>, <dispel.providers.generic.flags.le_flags.PercentageNotMoving object>, <dispel.providers.generic.flags.le_flags.LargeTurnsPerMinute object>]#

class dispel.providers.generic.tasks.gait.steps.GaitCoreSteps[source]#

Bases: ProcessingStepGroup

Core steps to process gait measures.

level_filter: LevelFilter = <LastLevelFilter: last level>#

Parameters:: levels (Iterable[Level]) –
Return type:: Set[Level]

steps: List[ProcessingStep] = [<dispel.providers.generic.tasks.gait.steps.GaitPreprocessingSteps object>, <dispel.providers.generic.tasks.gait.steps.TremorSteps object>, <dispel.providers.generic.tasks.gait.steps.WalkingBoutDynamicsDetectionSteps object>, <dispel.providers.generic.tasks.gait.steps.PlacementClassificationSteps object>, <dispel.providers.generic.tasks.gait.steps.TurnDetectionSteps object>, <dispel.providers.generic.tasks.gait.steps.MergeDynamicsPlacementTurn object>, <dispel.providers.generic.tasks.gait.steps.CWTSteps object>, <dispel.providers.generic.tasks.gait.steps.CWTMeasureSteps object>, <dispel.providers.generic.tasks.gait.steps.StepsDistanceInertial object>]#

class dispel.providers.generic.tasks.gait.steps.GaitPreprocessingSteps[source]#

Bases: ProcessingStepGroup

Steps to pre-process gait activities.

steps: List[ProcessingStep] = [<dispel.providers.generic.preprocessing.PreprocessingSteps object>, <dispel.providers.generic.preprocessing.PreprocessingSteps object>]#

class dispel.providers.generic.tasks.gait.steps.GaitSteps[source]#

Bases: ProcessingStepGroup

Gait processing steps.

kwargs: Dict[str, Any] = {'task_name': Six-minute walk test (6MWT)}#

steps: List[ProcessingStep] = [<dispel.processing.assertions.AssertEvaluationFinished object>, <dispel.providers.generic.tasks.gait.steps.TechnicalFlags object>, <dispel.providers.generic.tasks.gait.steps.StepsGPS object>, <dispel.providers.generic.tasks.gait.steps.GaitCoreSteps object>, <dispel.providers.generic.tasks.gait.steps.FlagPreprocessing object>, <dispel.providers.generic.tasks.gait.steps.BehavioralDeviations object>, <dispel.providers.generic.tasks.gait.steps.BehavioralInvalidations object>]#

class dispel.providers.generic.tasks.gait.steps.GaitStepsInclLee[source]#

Bases: ProcessingStepGroup

Gait processing steps including Lee measures.

kwargs: Dict[str, Any] = {'task_name': Six-minute walk test (6MWT)}#

level_filter: LevelFilter = <LastLevelFilter: last level>#

Parameters:: levels (Iterable[Level]) –
Return type:: Set[Level]

steps: List[ProcessingStep] = [<dispel.providers.generic.tasks.gait.steps.GaitSteps object>, <dispel.providers.generic.tasks.gait.steps.LeeDetectionAndTransformSteps object>, <dispel.providers.generic.tasks.gait.steps.LeeMeasureSteps object>]#

class dispel.providers.generic.tasks.gait.steps.GaitTremorMeasures[source]#

Bases: ProcessingStepGroup

A group of gait steps for tremor measures.

new_column_names = {'userAccelerationX': 'x', 'userAccelerationY': 'y', 'userAccelerationZ': 'z'}#

steps: List[ProcessingStep] = [<dispel.providers.generic.sensor.RenameColumns object>, <dispel.providers.generic.tremor.TremorMeasures object>, <dispel.providers.generic.tremor.TremorMeasures object>]#

class dispel.providers.generic.tasks.gait.steps.LeeDetectionAndTransformSteps[source]#

Bases: ProcessingStepGroup

Lee et al. step detection processing steps.

steps: List[ProcessingStep] = [<dispel.providers.generic.tasks.gait.lee.LeeDetectSteps object>, <dispel.providers.generic.tasks.gait.lee.LeeDetectStepsWithoutBout object>, <dispel.providers.generic.tasks.gait.core.TransformStepDuration object>, <dispel.providers.generic.tasks.gait.core.TransformStepDurationWithoutBout object>, <dispel.providers.generic.tasks.gait.lee.LeeTransformHipRotation object>, <dispel.providers.generic.tasks.gait.lee.LeeTransformHipRotation object>]#

class dispel.providers.generic.tasks.gait.steps.LeeMeasureSteps[source]#

Bases: ProcessingStepGroup

Lee et al. measure extraction steps.

steps: List[ProcessingStep] = [<dispel.providers.generic.tasks.gait.lee.LeeMeasuresGroup object>, <dispel.providers.generic.tasks.gait.lee.LeeMeasuresGroup object>, <dispel.providers.generic.tasks.gait.lee.LeeMeasuresGroup object>, <dispel.providers.generic.tasks.gait.lee.LeeMeasuresWithoutBoutGroup object>]#

class dispel.providers.generic.tasks.gait.steps.MergeDynamicsPlacementTurn[source]#

Bases: ProcessingStepGroup

Detect walking bouts filtered for placement and no turns.

steps: List[ProcessingStep] = [<dispel.providers.generic.tasks.gait.core.DetectBoutsBeltPlacementNoTurns object>]#

class dispel.providers.generic.tasks.gait.steps.PlacementClassificationSteps[source]#

Bases: ProcessingStepGroup

Steps to classify device placement.

steps: List[ProcessingStep] = [<dispel.providers.generic.sensor.Resample object>, <dispel.providers.generic.sensor.EuclideanNorm object>, <dispel.providers.generic.activity.placement.ClassifyPlacement object>]#

class dispel.providers.generic.tasks.gait.steps.SixMinuteWalkTestMeasures[source]#

Bases: ExtractMultipleStep

A group of Gait extraction steps.

data_set_ids: str | Iterable[str] = 'distance_and_speed'#: An iterable of data sets to be being processed

definition: ValueDefinition | ValueDefinitionPrototype | None = <dispel.data.measures.MeasureValueDefinitionPrototype object>#: The specification of the measure definition

transform_functions: Iterable[Dict[str, Any]] = [{'description': 'The total distance walked during six minutes. The distance is measured based on GPS positions taken each second and derived to result in total distance.', 'func': <function agg_column.<locals>._function>, 'measure_name': total distance walked (distance_walked), 'unit': 'm'}, {'aggregation': 'mean', 'description': 'Mean walking speed measured using GPS positions measured each second excluding periods where between two measurements the displacement was smaller than one meter.', 'func': <function agg_column.<locals>._function>, 'measure_name': walking speed (excluding stops) (walking_speed_non_stop), 'unit': 'm/s'}]#

class dispel.providers.generic.tasks.gait.steps.StepsDistanceInertial[source]#

Bases: ProcessingStepGroup

Distance inertial processing steps.

steps: List[ProcessingStep] = [<dispel.providers.generic.tasks.gait.steps.ComputeDistanceInertial object>]#

class dispel.providers.generic.tasks.gait.steps.StepsGPS[source]#

Bases: ProcessingStepGroup

Steps to process measures from GPS signals.

level_filter: LevelFilter = <LastLevelFilter: last level>#

Parameters:: levels (Iterable[Level]) –
Return type:: Set[Level]

steps: List[ProcessingStep] = [<dispel.providers.generic.tasks.gait.steps.ComputeDistanceAndSpeed object>, <dispel.providers.generic.tasks.gait.steps.SixMinuteWalkTestMeasures object>]#

class dispel.providers.generic.tasks.gait.steps.TechnicalFlags[source]#

Bases: ProcessingStepGroup

Technical flag steps.

steps: List[ProcessingStep] = [<dispel.providers.generic.flags.generic.FrequencyLowerThanGaitThres object>, <dispel.providers.generic.flags.generic.MaxTimeIncrement object>]#

class dispel.providers.generic.tasks.gait.steps.TremorSteps[source]#

Bases: ProcessingStepGroup

Steps to extract tremor-based measures.

steps: List[ProcessingStep] = [<dispel.processing.transform.Apply object>, <dispel.providers.generic.tasks.gait.steps.GaitTremorMeasures object>]#

class dispel.providers.generic.tasks.gait.steps.TurnDetectionSteps[source]#

Bases: ProcessingStepGroup

Steps to detect turns.

steps: List[ProcessingStep] = [<dispel.providers.generic.activity.turning.ElGoharyTurnDetection object>]#

class dispel.providers.generic.tasks.gait.steps.WalkingBoutDetectionSteps[source]#

Bases: ProcessingStepGroup

Steps to detect walking bouts.

steps: List[ProcessingStep] = [<dispel.providers.generic.tasks.gait.core.AverageRollingVerticalAcceleration object>, <dispel.providers.generic.tasks.gait.core.DetectBoutsHarmonic object>]#

class dispel.providers.generic.tasks.gait.steps.WalkingBoutDynamicsDetectionSteps[source]#

Bases: ProcessingStepGroup

Steps to detect dynamic walking bouts.

steps: List[ProcessingStep] = [<dispel.providers.generic.tasks.gait.core.AverageRollingVerticalAcceleration object>, <dispel.providers.generic.tasks.gait.core.DetectMovementBouts object>]#