dispel.providers.generic.tasks.sbt_utt.sbt_bouts module#

A module that contains functionality to filter SBT bouts.

class dispel.providers.generic.tasks.sbt_utt.sbt_bouts.AfterFiveSec[source]#

Bases: SBTBoutStrategy

Create a view of the data, returning data after five seconds.

get_view(data)[source]#

Overwrite filter to return data after five seconds.

Parameters:

data (DataFrame | List[DataFrame]) –

Return type:

List[DataFrame]

class dispel.providers.generic.tasks.sbt_utt.sbt_bouts.FirstFiveSec[source]#

Bases: SBTBoutStrategy

Create a view of the data, returning data within first five seconds.

get_view(data)[source]#

Overwrite filter to return data within first five seconds.

Parameters:

data (DataFrame | List[DataFrame]) –

Return type:

List[DataFrame]

class dispel.providers.generic.tasks.sbt_utt.sbt_bouts.SBTBoutExtractStep[source]#

Bases: ExtractStep

Base class for SBT bouts measure extraction.

__init__(*args, **kwargs)[source]#
bout_strategy: SBTBoutStrategy#
process_level(level, reading, **kwargs)[source]#

Overwrite process_level.

Parameters:
Return type:

Generator[ProcessingResult | ProcessingControlResult, None, None]

class dispel.providers.generic.tasks.sbt_utt.sbt_bouts.SBTBoutStrategy[source]#

Bases: object

A generic class to help filter datasets.

get_view(data)[source]#

Create a view of the datasets.

Parameters:

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.sbt_utt.sbt_bouts.SBTBoutStrategyModality[source]#

Bases: AVEnum

Enumerate bout strategy modalities.

AFTER_FIVE = 2#
BASIC = 3#
FIRST_FIVE = 1#
property bout_cls#

Return BoutStrategy instance.