TimestampVectorData

See also:

Format Specification or Source Specification for TimestampVectorData.

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

Bases: types.hdmf_common.VectorData, types.untyped.DatasetClass

TIMESTAMPVECTORDATA - A 1-dimensional VectorData that stores timestamps in seconds from the session start time. Timestamp are not required to be sorted in time.

Required Properties*:

data, description

Constructor Summary
TimestampVectorData(varargin)

TIMESTAMPVECTORDATA - Constructor for TimestampVectorData

Syntax:

timestampVectorData = types.core.TIMESTAMPVECTORDATA() creates a TimestampVectorData object with unset property values.

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

Input Arguments (Name-Value Arguments):

  • data (single) - Data property for dataset class (TimestampVectorData)

  • description (char) - Description of what these vectors represent.

  • resolution (single) - The temporal resolution of the timestamps, in seconds. This is typically the sampling period (1 / sampling_rate), also known as the clock period, of the data acquisition system from which the timestamps were recorded or derived.

Output Arguments:
Property Summary
resolution

(single) The temporal resolution of the timestamps, in seconds. This is typically the sampling period (1 / sampling_rate), also known as the clock period, of the data acquisition system from which the timestamps were recorded or derived.

unit = "seconds"

(char) The unit of measurement for the timestamps, fixed to ‘seconds’.

Tip

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