dispel.providers.ads.data module#

ADS exclusive data model for the analysis library.

class dispel.providers.ads.data.ADSModalities[source]#

Bases: Modalities

An entity to match level context modalities with a Level.id.

Specific to ADS Readings.

__init__(app_version)[source]#

Parameters:: app_version (str | None) –

static get_cps_level_from_context(context)[source]#

Find the level from context enumerating through the modalities.

This function is specific to the ADS CPS test.

Parameters:: context (Context) – The context of the level in question.
Returns:: The snake case level name.
Return type:: str

static get_drawing_level_from_context(context)[source]#

Find the level from context enumerating through the modalities.

This function is specific to the ADS CPS test.

Parameters:: context (Context) – The context of the level in question.
Returns:: The snake case level name.
Return type:: str

static get_gait_level_from_context(_)[source]#

Find the only level of the ADS 6MW test.

Parameters:: _ (List) –
Return type:: str

static get_grip_level_from_context(context)[source]#

Find the level from context enumerating through the modalities.

This function is specific to the ADS GRIP test.

Parameters:: context (Context) – The context of the level in question.
Returns:: The snake case level name.
Return type:: str

static get_mood_level_from_context(context)[source]#

Find the level from context enumerating through the modalities.

This function is specific to the ADS MOOD survey.

Parameters:: context (Context) – The context of the level in question.
Returns:: The snake case level name.
Return type:: str

static get_msis29_level_from_context(context)[source]#

Find the level from context enumerating through the modalities.

This function is specific to the ADS MSIS-29 test.

Parameters:: context (Context) – The context of the level in question.
Returns:: The snake case level name.
Return type:: str

static get_passive_level_from_context(_)[source]#

Find the only level of the ADS Passive test.

Parameters:: _ (List) –
Return type:: str

get_pinch_level_from_context(context)[source]#

Find the level from context enumerating through the modalities.

This function is specific to the ADS Pinch test.

Parameters:: context (Context) – The context of the level in question.
Returns:: The snake case level name.
Return type:: str
Raises:: ValueError – If the radius of pinch bubble does not correspond to any known radius interval.

static get_sbt_utt_level_from_context(context)[source]#

Find the level from context enumerating through the modalities.

This function is specific to the ADS SBT-UTT test.

Parameters:: context (Context) – The context of the level in question.
Returns:: The snake case level name.
Return type:: str

property is_default_mode#: Return whether the app version is the default mode.

class dispel.providers.ads.data.ADSReading[source]#

Bases: Reading

A data capture from an ADS experiment.

Parameters:

evaluation – The evaluation information
session – The session information
levels – An iterable of levels
measure_set – A list of measures already processed on the device
schema – The schema of the reading
date – The time the reading was recorded
device – The device that captured the reading

__init__(evaluation, session, levels=None, measure_set=None, schema=None, date=None, device=None)[source]#

Parameters:

evaluation (Evaluation) –
session (Session) –
levels (Iterable[Level] | None) –
measure_set (MeasureSet | None) –
schema (ReadingSchema | None) –
date (Any | None) –
device (Device | None) –

dispel.providers.ads.data.get_snake_case_context_value(context, key)[source]#

Find the context with its name into the list, converted in snake case.

Parameters:

context (Context) – A dispel.data.core.Context.
key (str) – The desire levelType

Returns:

The context value into snake case

Return type:

str