VectorIndex

See also:

Format Specification or Source Specification for VectorIndex.

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

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

VECTORINDEX - Used with VectorData to encode a ragged array. An array of indices into the first dimension of the target VectorData, forming a map between the rows of a DynamicTable and the indices of the VectorData. The name of the VectorIndex is expected to be the name of the target VectorData object followed by “_index”.

Required Properties*:

data, description, target

Constructor Summary
VectorIndex(varargin)

VECTORINDEX - Constructor for VectorIndex

Syntax:

vectorIndex = types.hdmf_common.VECTORINDEX() creates a VectorIndex object with unset property values.

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

Input Arguments (Name-Value Arguments):

  • data (uint8) - Data property for dataset class (VectorIndex)

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

  • target (Object reference to VectorData) - Reference to the target dataset that this index applies to.

Output Arguments:
Property Summary
target

REQUIRED (Object reference to VectorData) Reference to the target dataset that this index applies to.

Method Summary
validate_target(val)

Reference to type VectorData

Tip

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