allensdk.brain_observatory.behavior.mtrain module

class allensdk.brain_observatory.behavior.mtrain.ExtendedTrialSchema(*, only: Sequence[str] | AbstractSet[str] | None = None, exclude: Sequence[str] | AbstractSet[str] = (), many: bool | None = None, context: dict | None = None, load_only: Sequence[str] | AbstractSet[str] = (), dump_only: Sequence[str] | AbstractSet[str] = (), partial: bool | Sequence[str] | AbstractSet[str] | None = None, unknown: str | None = None)

Bases: Schema

This schema describes the edf core trial structure

dump_fields: dict[str, Field]

exclude: set[Any] | MutableSet[Any]

fields: dict[str, Field]

Dictionary mapping field_names -> Field objects

load_fields: dict[str, Field]

opts: Any = <marshmallow.schema.SchemaOpts object>

class allensdk.brain_observatory.behavior.mtrain.FriendlyDate(format: str | None = None, **kwargs)

Bases: Date

class allensdk.brain_observatory.behavior.mtrain.FriendlyDateTime(format: str | None = None, **kwargs)

Bases: DateTime

allensdk.brain_observatory.behavior.mtrain.annotate_change_detect(trials)

adds change and detect columns to dataframe

Parameters:

trialspandas DataFrame

dataframe of trials

inplacebool, optional

modify trials in place. if False, returns a copy. default: True

See also

io.load_trials

allensdk.brain_observatory.behavior.mtrain.annotate_trials(trials)

performs multiple annotatations:

• annotate_change_detect

• fix_change_time

• explode_response_window

Parameters:

trialspandas DataFrame

dataframe of trials

inplacebool, optional

modify trials in place. if False, returns a copy. default: True

See also

io.load_trials

allensdk.brain_observatory.behavior.mtrain.assign_session_id(trials)

adds a column with a unique ID for the session defined as

a combination of the mouse ID and startdatetime

Parameters:

trialspandas DataFrame

dataframe of trials

inplacebool, optional

modify trials in place. if False, returns a copy. default: True

See also

io.load_trials

allensdk.brain_observatory.behavior.mtrain.explode_response_window(trials)

explodes the response_window column in lower & upper columns

Parameters:

trialspandas DataFrame

dataframe of trials

inplacebool, optional

modify trials in place. if False, returns a copy. default: True

See also

io.load_trials

allensdk.brain_observatory.behavior.mtrain.fix_change_time(trials)

forces None values in the change_time column to numpy NaN

Parameters:

trialspandas DataFrame

dataframe of trials

inplacebool, optional

modify trials in place. if False, returns a copy. default: True

See also

io.load_trials