AnnotationSeries

See also:

Format Specification or Source Specification for AnnotationSeries.

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

Bases: types.core.TimeSeries, types.untyped.GroupClass

ANNOTATIONSERIES - DEPRECATED. Use an EventsTable instead, placed in the top-level /events group of the NWBFile. The timestamps field maps to the timestamp column, and the data field (annotation strings) maps to the annotation column on EventsTable. Use the source_description attribute on the EventsTable to record where the annotations came from (e.g., “Manual video review”). Original definition: Stores user annotations made during an experiment. The data[] field stores a text array, and timestamps are stored for each annotation (ie, interval=1). This is largely an alias to a standard TimeSeries storing a text array but that is identifiable as storing annotations in a machine-readable way.

Required Properties*:

data

Constructor Summary
AnnotationSeries(varargin)

ANNOTATIONSERIES - Constructor for AnnotationSeries

Syntax:

annotationSeries = types.core.ANNOTATIONSERIES() creates an AnnotationSeries object with unset property values.

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

Input Arguments (Name-Value Arguments):

  • comments (char) - Human-readable comments about the TimeSeries. This second descriptive field can be used to store additional information, or descriptive information if the primary description field is populated with a computer-readable string.

  • control (uint8) - Numerical labels that apply to each time point in data for the purpose of querying and slicing data by these values. If present, the length of this array should be the same size as the first dimension of data.

  • control_description (char) - Description of each control value. Must be present if control is present. If present, control_description[0] should describe time points where control == 0.

  • data (char) - Annotations made during an experiment.

  • data_continuity (char) - Optionally describe the continuity of the data. Can be “continuous”, “instantaneous”, or “step”. For example, a voltage trace would be “continuous”, because samples are recorded from a continuous process. An array of lick times would be “instantaneous”, because the data represents distinct moments in time. Times of image presentations would be “step” because the picture remains the same until the next timepoint. This field is optional, but is useful in providing information about the underlying data. It may inform the way this data is interpreted, the way it is visualized, and what analysis methods are applicable. For storing instantaneous event information, it is recommended to use an EventsTable instead of a TimeSeries with continuity set to “instantaneous”.

  • data_conversion (single) - Scalar to multiply each element in data to convert it to the specified ‘unit’. If the data are stored in acquisition system units or other units that require a conversion to be interpretable, multiply the data by ‘conversion’ to convert the data to the specified ‘unit’. e.g. if the data acquisition system stores values in this object as signed 16-bit integers (int16 range -32,768 to 32,767) that correspond to a 5V range (-2.5V to 2.5V), and the data acquisition system gain is 8000X, then the ‘conversion’ multiplier to get from raw data acquisition values to recorded volts is 2.5/32768/8000 = 9.5367e-9.

  • data_offset (single) - Scalar to add to the data after scaling by ‘conversion’ to finalize its coercion to the specified ‘unit’. Two common examples of this include (a) data stored in an unsigned type that requires a shift after scaling to re-center the data, and (b) specialized recording devices that naturally cause a scalar offset with respect to the true units.

  • description (char) - Description of the time series.

  • starting_time (double) - Timestamp of the first sample in seconds. When timestamps are uniformly spaced, the timestamp of the first sample can be specified and all subsequent ones calculated from the sampling rate attribute.

  • starting_time_rate (single) - Sampling rate, in Hz.

  • timestamps (double) - Timestamps for samples stored in data, in seconds, relative to the common experiment master-clock stored in NWBFile.timestamps_reference_time.

Output Arguments:

Tip

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