allensdk.brain_observatory.behavior.mtrain module

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

Bases: Schema

This schema describes the edf core trial structure

opts: SchemaOpts = <marshmallow.schema.SchemaOpts object>
class allensdk.brain_observatory.behavior.mtrain.FriendlyDate(format: str | None = None, **kwargs)[source]

Bases: Date

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

Bases: DateTime

allensdk.brain_observatory.behavior.mtrain.annotate_change_detect(trials)[source]

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)[source]

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)[source]
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)[source]

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)[source]

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