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

A module that contain functionality to filter walking bouts.

class dispel.providers.generic.tasks.gait.bout_strategy.BoutStrategy[source]#

Bases: object

A generic class to help filter datasets.

get_view(bouts, *data)[source]#

Create a view of the datasets.

A user can combined information from the walking bout detection and the datasets to generate a view of the data on which walking measures will be computed.

Parameters:

bouts (DataFrame) – Output of the walking bout detection.
data (DataFrame | List[DataFrame]) – Any dataset or list of datasets.

Returns:

A list of the same dataset under a defined view.

Return type:

List

class dispel.providers.generic.tasks.gait.bout_strategy.BoutStrategyModality[source]#

Bases: AVEnum

Enumerate bout strategy modalities.

BASIC = 3#

FIRST_TWO = 1#

LONGEST = 2#

property bout_cls#: Return BoutStrategy instance.

class dispel.providers.generic.tasks.gait.bout_strategy.FirstTwoMinBoutStrategy[source]#

Bases: BoutStrategy

Create a view of the data returning the first two minutes.

get_view(bouts, *data)[source]#

Overwrite filter to return the first two minutes of the data.

Parameters:

bouts (DataFrame) –
data (DataFrame | List[DataFrame]) –

Return type:

List[DataFrame]

class dispel.providers.generic.tasks.gait.bout_strategy.LongestBoutStrategy[source]#

Bases: BoutStrategy

Create a view of the data intersecting the longest walking bout.

get_view(bouts, *data)[source]#

Overwrite filter to return longest walking bout.

Parameters:

bouts (DataFrame) –
data (DataFrame | List[DataFrame]) –

Return type:

List[DataFrame]