dispel.providers.generic.tasks.cps.modalities module#

A module containing functionality to process/filter specific modalities.

class dispel.providers.generic.tasks.cps.modalities.CPSKeySet[source]#

Bases: AVEnum

Enumerated constant representing the key set modalities.

KEY1 = 1#

KEY2 = 2#

KEY3 = 3#

RANDOM = 4#

class dispel.providers.generic.tasks.cps.modalities.CPSLevel[source]#

Bases: str, Enum

An enum for CPS levels.

DIGIT_TO_DIGIT = 'digit_to_digit'#

SYMBOL_TO_DIGIT = 'symbol_to_digit'#

class dispel.providers.generic.tasks.cps.modalities.CPSModalityFilter[source]#

Bases: LevelFilter

Filter over levels, sequences, and key sets.

__init__(mode, sequence, key_set=None)[source]#

Parameters:

mode (CPSMode) –
sequence (CPSSequence) –
key_set (CPSKeySet | None) –

filter(levels)[source]#

Filter for levels.

Parameters:: levels (Iterable[Level]) –
Return type:: Set[Level]

property key_set_context_id: str#: Return the proper key set context id.

property level_id: CPSLevel#: Return the proper level id.

repr()[source]#

Get representation of the filter.

Return type:: str

property sequence_context_id: str#: Return the proper sequence context id.

class dispel.providers.generic.tasks.cps.modalities.CPSMode[source]#

Bases: AVEnum

Enumerated constant representing the level modalities.

DIGIT_TO_DIGIT = 2#

SYMBOL_TO_DIGIT = 1#

class dispel.providers.generic.tasks.cps.modalities.CPSSequence[source]#

Bases: AVEnum

Enumerated constant representing the sequence type.

PRE_DEFINED = 1#

RANDOM = 2#

class dispel.providers.generic.tasks.cps.modalities.DigitConfusionPairModality[source]#

Bases: PairModalityBase

Enumerated digit confusions modalities.

DIGIT_6_9 = 1#

DIGIT_9_6 = 2#

class dispel.providers.generic.tasks.cps.modalities.DigitEnum[source]#

Bases: AVEnum

Enumerated constant of the digits for the d2d phase.

DIGIT_1 = 1#

DIGIT_2 = 2#

DIGIT_3 = 3#

DIGIT_4 = 4#

DIGIT_5 = 5#

DIGIT_6 = 6#

DIGIT_7 = 7#

DIGIT_8 = 8#

DIGIT_9 = 9#

dispel.providers.generic.tasks.cps.modalities.INTERACT_DURATION_VALIDATOR = <RangeValidator: [0, 10]>#

The maximum time for the user to interact during an attempt of an upper task

Parameters:: value (Any) –

dispel.providers.generic.tasks.cps.modalities.NBACKS = range(1, 4)#: range of n-backs studied

class dispel.providers.generic.tasks.cps.modalities.PairModalityBase[source]#

Bases: AVEnum

Enumerated pair modalities base.

classmethod from_pair(left, right)[source]#

Extract PairModality for a given pair of keys.

Parameters:

left (AVEnum) –
right (AVEnum) –

Return type:

PairModalityBase

class dispel.providers.generic.tasks.cps.modalities.RegressionMode[source]#

Bases: AVEnum

Enumerated constant representing the linear regression measures.

ALL_RESPONSES = 1#

ONE_ANS_REM = 2#

THREE_ANS_REM = 4#

TWO_ANS_REM = 3#

property to_drop: int#: Return the number of data points to be dropped in the regression.

class dispel.providers.generic.tasks.cps.modalities.ResponsesModality[source]#

Bases: AVEnum

Enumerated constant representing the specific selection modalities.

CORRECT = 3#

FIVE_FIRST = 1#

FIVE_LAST = 2#

class dispel.providers.generic.tasks.cps.modalities.SymbolConfusionPairModality[source]#

Bases: PairModalityBase

Enumerated symbol confusions modalities.

SYMBOL_2_7 = 1#

SYMBOL_3_8 = 5#

SYMBOL_4_6 = 3#

SYMBOL_6_4 = 4#

SYMBOL_7_2 = 2#

SYMBOL_8_3 = 6#

class dispel.providers.generic.tasks.cps.modalities.SymbolEnum[source]#

Bases: AVEnum

Enumerated constant representing symbol modalities.

SYMBOL_1 = 1#

SYMBOL_2 = 2#

SYMBOL_3 = 3#

SYMBOL_4 = 4#

SYMBOL_5 = 5#

SYMBOL_6 = 6#

SYMBOL_7 = 7#

SYMBOL_8 = 8#

SYMBOL_9 = 9#

class dispel.providers.generic.tasks.cps.modalities.SymmetryModality[source]#

Bases: AVEnum

Enumerated constant representing the coupling modalities.

PAIRED = 1#

UNIQUE = 2#

static get_pair_modality(mode)[source]#

Get pair values from modality.

Parameters:: mode (CPSMode) –
Return type:: List[SymbolEnum]

static get_unique_modality(mode)[source]#

Get Unique values from modality.

Parameters:: mode (CPSMode) –
Return type:: List[SymbolEnum]

dispel.providers.generic.tasks.cps.modalities.TOTAL_RESPONSES_VALIDATOR = <RangeValidator: [0, 120]>#

Range validator for maximum total responses

Parameters:: value (Any) –

class dispel.providers.generic.tasks.cps.modalities.ThirdsModality[source]#

Bases: AVEnum

Enumerated constant representing the specific set third modalities.

The Konectom symbol-to-digit cognitive processing speed test is decomposed into three sets (first, second, third). The sets are computed based on the total duration of the level obtained from the context. The length of a set is defined as the total_duration / 3.

FIRST_THIRD = 1#

SECOND_LAST_THIRD = 4#

SECOND_THIRD = 2#

THIRD_THIRD = 3#

get_lower_upper(data, duration)[source]#

Get third boundaries from data set.

Return type:: Tuple[int, int]

class dispel.providers.generic.tasks.cps.modalities.ThirdsPairModality[source]#

Bases: PairModalityBase

Enumerated comparisons between the different parts of the data set.

THIRD_2_1 = 1#

THIRD_3_1 = 2#

THIRD_3_2 = 3#