BehavioralEvents

See also:

Format Specification or Source Specification for BehavioralEvents.

class types.core.BehavioralEvents(varargin)[source]

Bases: types.core.NWBDataInterface, types.untyped.GroupClass, matnwb.mixin.HasUnnamedGroups

BEHAVIORALEVENTS - DEPRECATED. Use an EventsTable instead, placed in the top-level /events group of the NWBFile. Each TimeSeries formerly stored under BehavioralEvents becomes one EventsTable. The timestamps field maps to the timestamp column, and the data field maps to an additional column named after the event marker (e.g., reward_magnitude, port_number); for multi-dimensional data, use one column per field. Any other per-event metadata becomes additional columns. Use the source_description attribute on the EventsTable to record where the events came from (e.g., “Acquisition system”, “Thresholding of analog signal ANALOG1 at 3 V”, “Manual video review”). Original definition: TimeSeries for storing behavioral events. See description of BehavioralEpochs for more details.

Required Properties*:

timeseries

Constructor Summary
BehavioralEvents(varargin)

BEHAVIORALEVENTS - Constructor for BehavioralEvents

Syntax:

behavioralEvents = types.core.BEHAVIORALEVENTS() creates a BehavioralEvents object with unset property values.

behavioralEvents = types.core.BEHAVIORALEVENTS(Name, Value) creates a BehavioralEvents object where one or more property values are specified using name-value pairs.

Input Arguments (Name-Value Arguments):

  • timeseries (TimeSeries) - TimeSeries object containing behavioral events.

Output Arguments:
Property Summary
timeseries

REQUIRED (TimeSeries) TimeSeries object containing behavioral events.

Tip

* If a required property link is not functional, the property may be defined in a superclass. Please refer to the superclass documentation.