TimeIntervals

See also:

Format Specification or Source Specification for TimeIntervals.

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

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

TIMEINTERVALS - A column-based table to store information about time intervals, one interval per row. Use TimeIntervals when each row naturally has a start and stop time and represents a contiguous period of time, often encompassing an experimental condition. Rows can optionally reference TimeSeries data via the timeseries column. Examples include trials, epochs, behavioral states (e.g., “running”, “resting”), and invalid recording windows.

Required Properties*:

colnames, description, id, start_time, stop_time

Constructor Summary
TimeIntervals(varargin)

TIMEINTERVALS - Constructor for TimeIntervals

Syntax:

timeIntervals = types.core.TIMEINTERVALS() creates a TimeIntervals object with unset property values.

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

Input Arguments (Name-Value Arguments):

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

  • description (char) - Description of what is in this dynamic table.

  • 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”.

  • start_time (VectorData) - Start time of epoch, in seconds.

  • stop_time (VectorData) - Stop time of epoch, in seconds.

  • tags (VectorData) - User-defined tags that identify or categorize events.

  • tags_index (VectorIndex) - Index for tags.

  • timeseries (TimeSeriesReferenceVectorData) - An index into a TimeSeries object.

  • timeseries_index (VectorIndex) - Index for timeseries.

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

Output Arguments:
Property Summary
start_time

REQUIRED (VectorData) Start time of epoch, in seconds.

stop_time

REQUIRED (VectorData) Stop time of epoch, in seconds.

tags

(VectorData) User-defined tags that identify or categorize events.

tags_index

(VectorIndex) Index for tags.

timeseries

(TimeSeriesReferenceVectorData) An index into a TimeSeries object.

timeseries_index

(VectorIndex) Index for timeseries.

Tip

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