VectorData

See also:

Format Specification or Source Specification for VectorData.

class types.hdmf_common.VectorData(varargin)[source]

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

VECTORDATA - An n-dimensional dataset representing a column of a DynamicTable. If used without an accompanying VectorIndex, first dimension is along the rows of the DynamicTable and each step along the first dimension is a cell of the larger table. VectorData can also be used to represent a ragged array if paired with a VectorIndex. This allows for storing arrays of varying length in a single cell of the DynamicTable by indexing into this VectorData. The first vector is at VectorData[0:VectorIndex[0]]. The second vector is at VectorData[VectorIndex[0]:VectorIndex[1]], and so on.

Required Properties*:

data, description

Constructor Summary
VectorData(varargin)

VECTORDATA - Constructor for VectorData

Syntax:

vectorData = types.hdmf_common.VECTORDATA() creates a VectorData object with unset property values.

vectorData = types.hdmf_common.VECTORDATA(Name, Value) creates a VectorData object where one or more property values are specified using name-value pairs.

Input Arguments (Name-Value Arguments):

  • data (any) - Data property for dataset class (VectorData)

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

Output Arguments:
Property Summary
description

REQUIRED (char) Description of what these vectors represent.

Tip

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