allensdk.brain_observatory.behavior.mtrain module

class allensdk.brain_observatory.behavior.mtrain.ExtendedTrialSchema(*, only: Union[Sequence[str], Set[str], None] = None, exclude: Union[Sequence[str], Set[str]] = (), many: bool = False, context: Optional[Dict[KT, VT]] = None, load_only: Union[Sequence[str], Set[str]] = (), dump_only: Union[Sequence[str], Set[str]] = (), partial: Union[bool, Sequence[str], Set[str]] = False, unknown: Optional[str] = None)[source]

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: Optional[str] = None, **kwargs)[source]

Bases: marshmallow.fields.Date

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

Bases: marshmallow.fields.DateTime

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

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

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

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

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