dispel.providers.generic.tasks.sbt_utt.sbt_func module#
Functionality implemented in SBT.steps module.
- dispel.providers.generic.tasks.sbt_utt.sbt_func.circle_area(comp1, comp2)[source]#
Compute the area of a circle comprising data within the 95-percentile.
The area of the circle comprising data points of a timeseries within the 95-percentile is computed following Original paper (eq.12) by Prieto(1996) https://doi.org/10.1109/10.532130
- dispel.providers.generic.tasks.sbt_utt.sbt_func.data_coverage_fraction(data)[source]#
Compute the portion of data covered by a binary flag over signal length.
- dispel.providers.generic.tasks.sbt_utt.sbt_func.ellipse_area(comp1, comp2)[source]#
Compute Ellipse Area as the 95% percentile of the PCA-fitted axes.
The Ellipse Area is computed from the values of the estimated minor and major (a,b) axes of an ellipse. The axes are estimated using a 2-PCA component analyses on the 2-dimensional timeseries of data. The Ellipse area is computed as the multiplication of its semi-axes and the number pi.
- dispel.providers.generic.tasks.sbt_utt.sbt_func.label_bouts(data)[source]#
Label each valid and invalid chunk as a bout.
- Parameters:
data (Series) – A Series that contains one column including the flag continuous signal
- Returns:
A labelled pd.Series where each valid/invalid bout is assigned an increasing integer number
- Return type:
Series
- dispel.providers.generic.tasks.sbt_utt.sbt_func.reject_short_bouts(bout_mask, flag)[source]#
Reject bouts whose duration is less than MIN_MOTION_DUR seconds.
- Parameters:
- Returns:
A Series with a flag_signal where the valence has been inverted in case its duration is below MIN_MOTION_DUR seconds.
- Return type:
Series
- dispel.providers.generic.tasks.sbt_utt.sbt_func.sway_jerk(comp1, comp2)[source]#
Compute the jerk of the sway.
The Sway Jerk provides a means of quantifying the average sway occurred on a plane per time unit over the total of an assessment . It is a complementary measure to the sway areas, as it covers also the amount of sway occurred within a given geometric area. It takes special relevance when algorithms to remove outliers are applied and the timeseries span used for different measures is different. In other words, a normalised version of the sway total excursion. See an example of concomitant use with sway total excursion in Mancini(2012), https://doi.org/10.1186/1743-0003-9-59
- dispel.providers.generic.tasks.sbt_utt.sbt_func.sway_total_excursion(comp1, comp2)[source]#
Compute the total amount of acceleration increments on a plane.
The Sway Total Excursion (a.k.a. TOTEX) provides a means of quantifying how much sway occurred on a plane over the total of an assessment. It is a complementary measure to the sway areas, as it covers also the amount of sway occurred within a given geometric area.