dispel.processing package

Processing functionality.

dispel.processing.process(reading, steps, **kwargs)

Perform processing steps on a reading.

Parameters:

• reading (Reading) – The reading to be processed.

• steps (ProcessingStep | Iterable[ProcessingStep]) – An iterable of ProcessingSteps to be applied to the reading or a single processing step to be applied.

• kwargs – Additional named arguments are passed to the process() function.

Returns:

The data trace corresponding to the provided reading after applying the processing steps.

Return type:

DataTrace

Submodules

• dispel.processing.assertions module
  • AssertEvaluationFinished
    • AssertEvaluationFinished.process_reading()
  • AssertRawDataSetPresent
    • AssertRawDataSetPresent.__init__()
    • AssertRawDataSetPresent.__new__()
    • AssertRawDataSetPresent.process_level()
  • NotEmptyDataSetAssertionMixin
    • NotEmptyDataSetAssertionMixin.assert_valid_data_sets()
    • NotEmptyDataSetAssertionMixin.assertion_message
    • NotEmptyDataSetAssertionMixin.empty_data_set_handling
• dispel.processing.core module
  • CoreProcessingStepGroup
    • CoreProcessingStepGroup.__init__()
    • CoreProcessingStepGroup.__new__()
    • CoreProcessingStepGroup.get_kwargs()
    • CoreProcessingStepGroup.get_steps()
    • CoreProcessingStepGroup.kwargs
    • CoreProcessingStepGroup.process_reading()
    • CoreProcessingStepGroup.set_kwargs()
    • CoreProcessingStepGroup.set_steps()
    • CoreProcessingStepGroup.steps
  • ErrorHandling
    • ErrorHandling.IGNORE
    • ErrorHandling.RAISE
    • ErrorHandling.from_bool()
    • ErrorHandling.should_raise
  • FlagError
    • FlagError.__init__()
  • FlagReadingStep
    • FlagReadingStep.__init__()
    • FlagReadingStep.flag_reading()
    • FlagReadingStep.get_flag_targets()
    • FlagReadingStep.get_reading_flag_targets()
    • FlagReadingStep.process_reading()
  • InvalidDataError
  • Parameter
    • Parameter.__init__()
    • Parameter.__new__()
    • Parameter.has_parameter()
    • Parameter.id
    • Parameter.set_value()
    • Parameter.value
  • ProcessingControlResult
    • ProcessingControlResult.__init__()
    • ProcessingControlResult.error
    • ProcessingControlResult.error_handling
    • ProcessingControlResult.from_assertion_error()
    • ProcessingControlResult.from_flag()
    • ProcessingControlResult.get_targets()
    • ProcessingControlResult.targets
  • ProcessingError
    • ProcessingError.__init__()
  • ProcessingResult
    • ProcessingResult.__init__()
    • ProcessingResult.get_kwargs()
    • ProcessingResult.get_sources()
    • ProcessingResult.result
    • ProcessingResult.sources
  • ProcessingResultBase
    • ProcessingResultBase.__init__()
    • ProcessingResultBase.get_kwargs()
    • ProcessingResultBase.step
  • ProcessingStep
    • ProcessingStep.__init__()
    • ProcessingStep.assert_valid_reading()
    • ProcessingStep.chain()
    • ProcessingStep.flag_reading()
    • ProcessingStep.get_parameters()
    • ProcessingStep.get_reading_flag_targets()
    • ProcessingStep.process()
    • ProcessingStep.process_reading()
    • ProcessingStep.set_next()
    • ProcessingStep.set_previous()
  • StopProcessingError
• dispel.processing.data_set module
  • DataSetProcessingStep
    • DataSetProcessingStep.__init__()
    • DataSetProcessingStep.assert_valid_data_sets()
    • DataSetProcessingStep.flag_data_sets()
    • DataSetProcessingStep.process_data_sets()
    • DataSetProcessingStep.process_level()
  • DataSetProcessingStepMixin
    • DataSetProcessingStepMixin.__init__()
    • DataSetProcessingStepMixin.assert_valid_level()
    • DataSetProcessingStepMixin.data_set_ids
    • DataSetProcessingStepMixin.get_data_frames()
    • DataSetProcessingStepMixin.get_data_set_ids()
    • DataSetProcessingStepMixin.get_raw_data_sets()
  • DataSetProcessingStepProtocol
    • DataSetProcessingStepProtocol.assert_valid_data_sets()
    • DataSetProcessingStepProtocol.flag_data_sets()
    • DataSetProcessingStepProtocol.get_data_frames()
    • DataSetProcessingStepProtocol.get_data_set_ids()
    • DataSetProcessingStepProtocol.get_data_sets_flag_targets()
    • DataSetProcessingStepProtocol.get_raw_data_sets()
    • DataSetProcessingStepProtocol.process_data_sets()
  • FlagDataSetStep
    • FlagDataSetStep.__init__()
    • FlagDataSetStep.flag_data_sets()
    • FlagDataSetStep.get_data_sets_flag_targets()
    • FlagDataSetStep.get_flag_targets()
    • FlagDataSetStep.get_target_ids()
    • FlagDataSetStep.process_data_sets()
    • FlagDataSetStep.target_ids
  • MutateDataSetProcessingStepBase
    • MutateDataSetProcessingStepBase.__init__()
    • MutateDataSetProcessingStepBase.get_transform_function()
    • MutateDataSetProcessingStepBase.get_transform_functions()
    • MutateDataSetProcessingStepBase.process_data_sets()
    • MutateDataSetProcessingStepBase.transform_function
    • MutateDataSetProcessingStepBase.wrap_result()
  • RawDataSetProcessingResult
    • RawDataSetProcessingResult.__init__()
    • RawDataSetProcessingResult.concatenate
    • RawDataSetProcessingResult.overwrite
  • StorageError
    • StorageError.CONCATENATE
    • StorageError.IGNORE
    • StorageError.OVERWRITE
    • StorageError.RAISE
    • StorageError.concatenate
    • StorageError.overwrite
  • decorated_processing_function()
  • transformation()
• dispel.processing.data_trace module
  • DataTrace
    • DataTrace.__init__()
    • DataTrace.add_trace()
    • DataTrace.check_data_set_usage()
    • DataTrace.children()
    • DataTrace.entity_count
    • DataTrace.from_reading()
    • DataTrace.get_flags()
    • DataTrace.get_measure_flags()
    • DataTrace.get_reading()
    • DataTrace.has_node()
    • DataTrace.is_leaf()
    • DataTrace.leaf_count
    • DataTrace.leaves()
    • DataTrace.nodes()
    • DataTrace.parents()
    • DataTrace.populate()
    • DataTrace.processing_step_count
  • EdgeNotFound
    • EdgeNotFound.__init__()
  • GraphNoCycle
    • GraphNoCycle.__init__()
  • MissingSourceNode
    • MissingSourceNode.__init__()
  • NodeHasMultipleParents
    • NodeHasMultipleParents.__init__()
  • NodeNotFound
    • NodeNotFound.__init__()
• dispel.processing.epochs module
  • CreateLevelEpochStep
    • CreateLevelEpochStep.epoch_data_set_id
    • CreateLevelEpochStep.get_epoch_data_set()
    • CreateLevelEpochStep.get_epoch_data_set_id()
    • CreateLevelEpochStep.storage_error
    • CreateLevelEpochStep.transform_data_frame_to_epochs()
    • CreateLevelEpochStep.transform_row_to_epoch()
    • CreateLevelEpochStep.wrap_result()
  • DefaultLevelEpochFilter
    • DefaultLevelEpochFilter.filter()
  • LevelEpochDefinitionMixIn
    • LevelEpochDefinitionMixIn.definition
    • LevelEpochDefinitionMixIn.__init__()
    • LevelEpochDefinitionMixIn.definition
    • LevelEpochDefinitionMixIn.get_definition()
  • LevelEpochExtractStep
    • LevelEpochExtractStep.get_value()
    • LevelEpochExtractStep.wrap_result()
  • LevelEpochFilter
    • LevelEpochFilter.filter()
  • LevelEpochIdFilter
    • LevelEpochIdFilter.__init__()
    • LevelEpochIdFilter.filter()
  • LevelEpochProcessingResult
    • LevelEpochProcessingResult.__init__()
    • LevelEpochProcessingResult.epoch
  • LevelEpochProcessingStepMixIn
    • LevelEpochProcessingStepMixIn.__init__()
    • LevelEpochProcessingStepMixIn.epoch_filter
    • LevelEpochProcessingStepMixIn.get_epoch_data_set_view()
    • LevelEpochProcessingStepMixIn.get_epoch_data_set_views()
    • LevelEpochProcessingStepMixIn.get_epoch_filter()
    • LevelEpochProcessingStepMixIn.get_epochs()
    • LevelEpochProcessingStepMixIn.process_data_sets()
• dispel.processing.extract module
  • AGGREGATION_CENTER_BASED
  • AGGREGATION_REGISTRY
  • AggregateMeasures
    • AggregateMeasures.__init__()
    • AggregateMeasures.aggregate()
    • AggregateMeasures.aggregation_method
    • AggregateMeasures.error_handler
    • AggregateMeasures.fail_if_missing
    • AggregateMeasures.get_measure_ids()
    • AggregateMeasures.get_measure_set()
    • AggregateMeasures.get_measure_values()
    • AggregateMeasures.get_measures()
    • AggregateMeasures.measure_ids
    • AggregateMeasures.process_reading()
    • AggregateMeasures.yield_if_nan
  • AggregateModalities
    • AggregateModalities.get_measure_ids()
    • AggregateModalities.get_modalities()
    • AggregateModalities.modalities
  • AggregateRawDataSetColumn
    • AggregateRawDataSetColumn.__init__()
    • AggregateRawDataSetColumn.aggregations
    • AggregateRawDataSetColumn.column_id
    • AggregateRawDataSetColumn.get_agg_func_and_kwargs()
    • AggregateRawDataSetColumn.get_aggregations()
    • AggregateRawDataSetColumn.get_column_id()
    • AggregateRawDataSetColumn.get_definition()
    • AggregateRawDataSetColumn.get_transform_functions()
  • BASIC_AGGREGATIONS
  • DEFAULT_AGGREGATIONS
  • DEFAULT_AGGREGATIONS_CV
  • DEFAULT_AGGREGATIONS_IQR
  • DEFAULT_AGGREGATIONS_Q95
  • EXTENDED_AGGREGATIONS
  • ExtractMultipleStep
    • ExtractMultipleStep.__init__()
    • ExtractMultipleStep.__new__()
    • ExtractMultipleStep.get_transform_functions()
    • ExtractMultipleStep.transform_functions
  • ExtractStep
    • ExtractStep.__init__()
    • ExtractStep.wrap_result()
    • ExtractStep.yield_if_nan
  • MeasureDefinitionMixin
    • MeasureDefinitionMixin.__init__()
    • MeasureDefinitionMixin.definition
    • MeasureDefinitionMixin.get_definition()
    • MeasureDefinitionMixin.get_value()
  • MeasureFlagStep
    • MeasureFlagStep.__init__()
    • MeasureFlagStep.flag_measure_values()
    • MeasureFlagStep.get_flag_targets()
    • MeasureFlagStep.get_measure_ids()
    • MeasureFlagStep.get_measure_values()
    • MeasureFlagStep.get_measures()
    • MeasureFlagStep.get_target_ids()
    • MeasureFlagStep.measure_ids
    • MeasureFlagStep.process_reading()
    • MeasureFlagStep.target_ids
  • agg_column()
• dispel.processing.flags module
  • FlagStepMixin
    • FlagStepMixin.__init__()
    • FlagStepMixin.flag_name
    • FlagStepMixin.flag_severity
    • FlagStepMixin.flag_type
    • FlagStepMixin.flagging_function
    • FlagStepMixin.get_flag()
    • FlagStepMixin.get_flag_name()
    • FlagStepMixin.get_flag_severity()
    • FlagStepMixin.get_flag_targets()
    • FlagStepMixin.get_flag_type()
    • FlagStepMixin.get_flagging_function()
    • FlagStepMixin.get_flagging_functions()
    • FlagStepMixin.get_reason()
    • FlagStepMixin.reason
    • FlagStepMixin.set_flag_kwargs()
    • FlagStepMixin.stop_processing
  • flag()
• dispel.processing.level module
  • DefaultLevelFilter
    • DefaultLevelFilter.filter()
    • DefaultLevelFilter.repr()
  • FlagLevelStep
    • FlagLevelStep.__init__()
    • FlagLevelStep.flag_level()
    • FlagLevelStep.get_flag_targets()
    • FlagLevelStep.get_level_flag_targets()
    • FlagLevelStep.process_level()
  • LevelFilter
    • LevelFilter.filter()
    • LevelFilter.repr()
  • LevelFilterProcessingStepMixin
    • LevelFilterProcessingStepMixin.__init__()
    • LevelFilterProcessingStepMixin.get_level_filter()
    • LevelFilterProcessingStepMixin.inject_level_filter_from_step()
    • LevelFilterProcessingStepMixin.level_filter
    • LevelFilterProcessingStepMixin.set_level_filter()
  • LevelIdFilter
    • LevelIdFilter.__init__()
    • LevelIdFilter.filter()
    • LevelIdFilter.repr()
  • LevelProcessingControlResult
    • LevelProcessingControlResult.__init__()
    • LevelProcessingControlResult.from_assertion_error()
    • LevelProcessingControlResult.from_flag()
  • LevelProcessingResult
    • LevelProcessingResult.__init__()
  • LevelProcessingResultBase
    • LevelProcessingResultBase.__init__()
    • LevelProcessingResultBase.level
  • LevelProcessingStep
    • LevelProcessingStep.assert_valid_level()
    • LevelProcessingStep.flag_level()
    • LevelProcessingStep.process_level()
    • LevelProcessingStep.process_reading()
  • LevelProcessingStepProtocol
    • LevelProcessingStepProtocol.assert_valid_level()
    • LevelProcessingStepProtocol.flag_level()
    • LevelProcessingStepProtocol.get_level_flag_targets()
    • LevelProcessingStepProtocol.process_level()
  • ProcessingStepGroup
    • ProcessingStepGroup.inject_level_filter_from_step()
    • ProcessingStepGroup.set_steps()
• dispel.processing.level_filters module
  • AbsentDataSetFilter
    • AbsentDataSetFilter.__init__()
    • AbsentDataSetFilter.filter()
    • AbsentDataSetFilter.repr()
  • DurationFilter
    • DurationFilter.__init__()
    • DurationFilter.filter()
    • DurationFilter.repr()
  • LastLevelFilter
    • LastLevelFilter.filter()
    • LastLevelFilter.repr()
  • NotEmptyDataSetFilter
    • NotEmptyDataSetFilter.__init__()
    • NotEmptyDataSetFilter.filter()
    • NotEmptyDataSetFilter.repr()
  • NotEmptyDatasetFilter
    • NotEmptyDatasetFilter.__init__()
    • NotEmptyDatasetFilter.filter()
    • NotEmptyDatasetFilter.repr()
• dispel.processing.modalities module
  • HandModality
    • HandModality.LEFT
    • HandModality.RIGHT
  • HandModalityFilter
    • HandModalityFilter.__init__()
    • HandModalityFilter.filter()
    • HandModalityFilter.repr()
  • LimbModality
    • LimbModality.LOWER_LIMB
    • LimbModality.UPPER_LIMB
  • SensorModality
    • SensorModality.ACCELEROMETER
    • SensorModality.GYROSCOPE
    • SensorModality.INTENTIONAL
    • SensorModality.unit()
• dispel.processing.trace module
  • DataSetTrace
    • DataSetTrace.data_set_id
    • DataSetTrace.definition
    • DataSetTrace.__init__()
    • DataSetTrace.data_set_id
    • DataSetTrace.definition
    • DataSetTrace.trace_type
  • EpochTrace
    • EpochTrace.epoch
    • EpochTrace.__init__()
    • EpochTrace.epoch
    • EpochTrace.trace_type
  • MeasureTrace
    • MeasureTrace.measure
    • MeasureTrace.__init__()
    • MeasureTrace.measure
    • MeasureTrace.step
    • MeasureTrace.trace_type
  • OriginTrace
    • OriginTrace.__init__()
    • OriginTrace.trace_type
  • StepGroupTrace
    • StepGroupTrace.__init__()
    • StepGroupTrace.trace_type
  • StepTrace
    • StepTrace.step
    • StepTrace.__init__()
    • StepTrace.step
    • StepTrace.trace_type
  • Trace
    • Trace.trace_type
    • Trace.__init__()
    • Trace.trace_type
  • TraceRelation
    • TraceRelation.GROUP
    • TraceRelation.INPUT
    • TraceRelation.OUTPUT
    • TraceRelation.SEQUENCE
  • TraceType
    • TraceType.DATA_SET
    • TraceType.EPOCH
    • TraceType.MEASURE
    • TraceType.ORIGIN
    • TraceType.STEP_GENERIC
    • TraceType.STEP_GROUP
  • collect_measure_value_definitions()
  • get_ancestor_source_graph()
  • get_ancestors()
  • get_edge_parameters()
  • get_traces()
  • inspect()
• dispel.processing.transform module
  • Add
    • Add.__init__()
  • Apply
    • Apply.__init__()
  • ConcatenateLevels
    • ConcatenateLevels.__init__()
    • ConcatenateLevels.get_levels()
    • ConcatenateLevels.process_reading()
  • SuffixBasedNewDataSetIdMixin
    • SuffixBasedNewDataSetIdMixin.__init__()
    • SuffixBasedNewDataSetIdMixin.get_new_data_set_id()
    • SuffixBasedNewDataSetIdMixin.get_suffix()
    • SuffixBasedNewDataSetIdMixin.suffix
  • TransformStep
    • TransformStep.__init__()
    • TransformStep.definitions
    • TransformStep.get_definitions()
    • TransformStep.get_new_data_set_id()
    • TransformStep.get_raw_data_set_definition()
    • TransformStep.new_data_set_id
    • TransformStep.process_level()
    • TransformStep.storage_error
    • TransformStep.wrap_result()
  • TransformStepChainMixIn
    • TransformStepChainMixIn.get_data_set_ids()
• dispel.processing.utils module
  • TaskMixin
    • TaskMixin.get_task_name()
    • TaskMixin.task_name
  • parallel_explode()