allensdk.brain_observatory.behavior.mtrain module

class allensdk.brain_observatory.behavior.mtrain.ExtendedTrialSchema(only=None, exclude=(), many=False, context=None, load_only=(), dump_only=(), partial=False, unknown=None)

Bases: marshmallow.schema.Schema

This schema describes the edf core trial structure

opts = <marshmallow.schema.SchemaOpts object>

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

Bases: marshmallow.fields.Date

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

Bases: marshmallow.fields.DateTime

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

adds change and detect columns to dataframe

Parameters:

trials : pandas DataFrame

dataframe of trials

inplace : bool, 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:

trials : pandas DataFrame

dataframe of trials

inplace : bool, 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:

trials : pandas DataFrame

dataframe of trials

inplace : bool, 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:

trials : pandas DataFrame

dataframe of trials

inplace : bool, 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:

trials : pandas DataFrame

dataframe of trials

inplace : bool, optional

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

See also

io.load_trials