EventsTable

See also:

Format Specification or Source Specification for EventsTable.

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

Bases: types.hdmf_common.DynamicTable, types.untyped.GroupClass

EVENTSTABLE - A column-based table to store information about events, one event per row. Use EventsTable when each row is anchored at a single timestamp and duration is absent, optional, or mixed across rows. Additional columns may be added to store metadata about each event, such as the duration of the event. Examples include TTL pulses, licks, rewards, stimulus onsets, and detected ripples. Each EventsTable should hold events of a single type, so that all rows share the same set of per-event metadata columns. Events of different types (e.g., licks and stimulus presentations) should be stored in separate EventsTable instances.

Required Properties*:

colnames, description, id, timestamp

Constructor Summary
EventsTable(varargin)

EVENTSTABLE - Constructor for EventsTable

Syntax:

eventsTable = types.core.EVENTSTABLE() creates an EventsTable object with unset property values.

eventsTable = types.core.EVENTSTABLE(Name, Value) creates an EventsTable object where one or more property values are specified using name-value pairs.

Input Arguments (Name-Value Arguments):

  • annotation (VectorData) - Column containing user annotations about events.

  • colnames (char) - The names of the columns in this table. This should be used to specify an order to the columns.

  • description (char) - A description of the events stored in the table, including information about how the event times were computed, especially if the times are the result of processing or filtering raw data. For example, if the experimenter is encoding different types of events using a strobed or N-bit encoding, then the description should describe which channels were used and how the event time is computed, e.g., as the rise time of the first bit.

  • duration (DurationVectorData) - Optional column containing the duration of each event, in seconds. A value of NaN can be used for events without a duration or with a duration that is not yet specified.

  • id (ElementIdentifiers) - Array of unique identifiers for the rows of this dynamic table.

  • meanings_tables (MeaningsTable) - MeaningsTable objects that provide meanings for values in VectorData columns within this DynamicTable. Tables should be named according to the column they provide meanings for with a “_meanings” suffix. e.g., if a VectorData column is named “stimulus_type”, the corresponding MeaningsTable should be named “stimulus_type_meanings”.

  • source_description (char) - Optional short text description of where the events came from, applying to every row in the table. For example, “Acquisition system” for events emitted directly by the acquisition system (e.g., TTL edges or hardware event channels); “Thresholding of analog signal ANALOG1 at 3 V” for events produced by a detection algorithm run on acquired data; or “Manual video review” for events added by a human annotator. This is a free-text label of origin only; use description for the longer narrative of how the event times were computed (channels used, encoding scheme, algorithm parameters, etc.).

  • timestamp (TimestampVectorData) - Column containing the time that each event occurred, in seconds, from the session start time.

  • vectordata (VectorData) - Vector columns, including index columns, of this dynamic table.

Output Arguments:
Property Summary
annotation

(VectorData) Column containing user annotations about events.

duration

(DurationVectorData) Optional column containing the duration of each event, in seconds. A value of NaN can be used for events without a duration or with a duration that is not yet specified.

source_description

(char) Optional short text description of where the events came from, applying to every row in the table. For example, “Acquisition system” for events emitted directly by the acquisition system (e.g., TTL edges or hardware event channels); “Thresholding of analog signal ANALOG1 at 3 V” for events produced by a detection algorithm run on acquired data; or “Manual video review” for events added by a human annotator. This is a free-text label of origin only; use description for the longer narrative of how the event times were computed (channels used, encoding scheme, algorithm parameters, etc.).

timestamp

REQUIRED (TimestampVectorData) Column containing the time that each event occurred, in seconds, from the session start time.

Tip

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