resurfemg.helper_functions.data_classes_quality_assessment module

Copyright 2022 Netherlands eScience Center and University of Twente Licensed under the Apache License, version 2.0. See LICENSE for details.

This file contains the quality assessment methods for data classes.

resurfemg.helper_functions.data_classes_quality_assessment.initialize_emg_tests(timeseries, peak_set_name, cutoff, skip_tests, parameter_names)

Initialize local parameters. See TimeSeries.test_emg_quality method in resurfemg.data_connector.data_classes for more information.

resurfemg.helper_functions.data_classes_quality_assessment.initialize_linked_peaks_tests(timeseries, peak_set_name, linked_timeseries, linked_peak_set_name, cutoff, skip_tests, parameter_names)

Initialize local parameter. See TimeSeries.test_linked_peak_sets method in resurfemg.data_connector.data_classes for more information.

resurfemg.helper_functions.data_classes_quality_assessment.initialize_pocc_tests(timeseries, peak_set_name, cutoff, skip_tests, parameter_names)

Initialize local parameters. See TimeSeries.test_pocc_quality method in resurfemg.data_connector.data_classes for more information.

resurfemg.helper_functions.data_classes_quality_assessment.test_aub(timeseries, peak_set, quality_outcomes_df, quality_values_df, cutoff)

Test percentage area under the baselineSee TimeSeries.test_emg_quality method in resurfemg.data_connector.data_classes for more information.

resurfemg.helper_functions.data_classes_quality_assessment.test_consecutive_poccs(timeseries, peak_set, quality_outcomes_df, parameter_names)

Test for consecutive Pocc manoeuvres. See TimeSeries.test_pocc_quality method in resurfemg.data_connector.data_classes for more information.

resurfemg.helper_functions.data_classes_quality_assessment.test_curve_fits(timeseries, peak_set, quality_outcomes_df, quality_values_df, cutoff, parameter_names)

Test curve fit. See TimeSeries.test_emg_quality method in resurfemg.data_connector.data_classes for more information.

resurfemg.helper_functions.data_classes_quality_assessment.test_emg_quality(self, peak_set_name, cutoff=None, skip_tests=None, parameter_names=None, verbose=True)

Test EMG PeaksSet according to quality criteria in Warnaar et al. (2024): interpeak_distance, snr, aub, curve_fit, and extended with relative area under the baseline (relative_aub) and relative ETP (relative_ETP). Peak validity is updated in the PeaksSet object. See postprocessing.quality_assessment submodule for details. ———————————————————————– :param peak_set_name: PeaksSet name in self.peaks dict :type peak_set_name: str :param cutoff: Cut-off criteria for passing the tests ‘tolerant’ and ‘strict’ can also be providedto use the values from Warnaar et al. :type cutoff: dict :param skip_tests: List of tests to skip. :type skip_tests: list :param parameter_names: Optionally refer to custom parameter names for default PeaksSet (ecg) :type parameter_names: dict :param verbose: Output the test values, and pass/fail to console. :type verbose: bool

Returns:

None

Return type:

None

resurfemg.helper_functions.data_classes_quality_assessment.test_event_timing(timeseries, native_peak_set, linked_timeseries, linked_peak_set, quality_outcomes_df, quality_values_df, cutoff)

Test event timing relative to other peak_set. See TimeSeries.test_linked_peak_sets method in resurfemg.data_connector.data_classes for more information.

resurfemg.helper_functions.data_classes_quality_assessment.test_fraction_detected_breaths(native_peak_set, linked_time_series, quality_outcomes_df, quality_values_df, n_peaks, cutoff, parameter_names)

Test detected peak fraction. See TimeSeries.test_linked_peak_sets method in resurfemg.data_connector.data_classes for more information.

resurfemg.helper_functions.data_classes_quality_assessment.test_interpeak_distance(timeseries, peak_set, quality_outcomes_df, n_peaks, cutoff)

Test interpeak distance. See TimeSeries.test_emg_quality method in resurfemg.data_connector.data_classes for more information.

resurfemg.helper_functions.data_classes_quality_assessment.test_linked_peak_sets(self, peak_set_name, linked_timeseries, linked_peak_set_name, parameter_names=None, cutoff=None, skip_tests=None, verbose=True)

Test number of detected breaths in the native PeaksSet compared to number (fraction_emg_breaths) of and timing peaks (event_timing) in the linked PeaksSet. Peak validity is updated in the PeaksSet object. ———————————————————————– :param peak_set_name: PeaksSet name in self.peaks dict :type peak_set_name: str :param linked_timeseries: TimeSeries object with linked signal :type linked_timeseries: TimeSeries :param linked_peak_set_name: PeaksSet name in linked_timeseries.peaks :type linked_peak_set_name: str :param parameter_names: Optionally refer to custom parameter names for default PeaksSet and parameter names (‘rr’, ) :type parameter_names: dict :param cutoff: Cut-off criteria for passing the tests. ‘tolerant’ and ‘strict’ can also be provided use the pre-defined values. :type cutoff: dict :param skip_tests: List of tests to skip. :type skip_tests: list :param verbose: Output the test values, and pass/fail to console. :type verbose: bool

Returns:

None

Return type:

None

resurfemg.helper_functions.data_classes_quality_assessment.test_pocc_quality(self, peak_set_name, cutoff=None, skip_tests=None, parameter_names=None, verbose=True)

Test EMG PeaksSet according to quality criteria in Warnaar et al. (2024): consecutive_poccs, and pocc_upslope. Peak validity is updated in the PeaksSet object. ———————————————————————– :param peak_set_name: PeaksSet name in self.peaks dict :type peak_set_name: str :param cutoff: Cut-off criteria for passing the tests. ‘tolerant’ and ‘strict’ can also be provided to use the values from Warnaar et al. :type cutoff: dict :param skip_tests: List of tests to skip. :type skip_tests: list :param parameter_names: Refer to custom parameter names for default PeaksSet and parameters (ventilator_breaths, time_product, AUB) :type parameter_names: dict :param verbose: Output the test values, and pass/fail to console. :type verbose: bool

Returns:

None

Return type:

None

resurfemg.helper_functions.data_classes_quality_assessment.test_pocc_upslope(timeseries, peak_set, quality_outcomes_df, quality_values_df, cutoff, parameter_names)

Test for sudden Pocc release. See TimeSeries.test_pocc_quality method in resurfemg.data_connector.data_classes for more information.

resurfemg.helper_functions.data_classes_quality_assessment.test_relative_aub(peak_set, quality_outcomes_df, cutoff)

Test the relative area under the baseline. See TimeSeries.test_emg_quality method in resurfemg.data_connector.data_classes for more information.

resurfemg.helper_functions.data_classes_quality_assessment.test_relative_etp(peak_set, quality_outcomes_df, cutoff, parameter_names)

Evaluate extremely low and high timeproducts. See TimeSeries.test_emg_quality method in resurfemg.data_connector.data_classes for more information.

resurfemg.helper_functions.data_classes_quality_assessment.test_snr(timeseries, peak_set, quality_outcomes_df, quality_values_df, cutoff)

Test signal-to-noise ratio. See TimeSeries.test_emg_quality method in resurfemg.data_connector.data_classes for more information.