AlignedDynamicTable

See also:: Format Specification or Source Specification for AlignedDynamicTable.

class types.hdmf_common.AlignedDynamicTable(varargin)[source]

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

ALIGNEDDYNAMICTABLE - DynamicTable container that supports storing a collection of sub-tables. Each sub-table is a DynamicTable itself that is aligned with the main table by row index. I.e., all DynamicTables stored in this group MUST have the same number of rows. This type effectively defines a 2-level table in which the main data is stored in the main table implemented by this type and additional columns of the table are grouped into categories, with each category being represented by a separate DynamicTable stored within the group.

Required Properties*:: categories, colnames, description, id

Constructor Summary

AlignedDynamicTable(varargin)

ALIGNEDDYNAMICTABLE - Constructor for AlignedDynamicTable

Syntax:

alignedDynamicTable = types.hdmf_common.ALIGNEDDYNAMICTABLE() creates a AlignedDynamicTable object with unset property values.

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

Input Arguments (Name-Value Arguments):

categories (char) - The names of the categories in this AlignedDynamicTable. Each category is represented by one DynamicTable stored in the parent group. This attribute should be used to specify an order of categories and the category names must match the names of the corresponding DynamicTable in the group.
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.
dynamictable (DynamicTable) - A DynamicTable representing a particular category for columns in the AlignedDynamicTable parent container. The table MUST be aligned with (i.e., have the same number of rows) as all other DynamicTables stored in the AlignedDynamicTable parent container. The name of the category is given by the name of the DynamicTable and its description by the description attribute of the DynamicTable.
id (ElementIdentifiers) - Array of unique identifiers for the rows of this dynamic table.
vectordata (VectorData) - Vector columns, including index columns, of this dynamic table.

Output Arguments:

alignedDynamicTable (types.hdmf_common.AlignedDynamicTable) - A AlignedDynamicTable object

Property Summary

categories: REQUIRED (char) The names of the categories in this AlignedDynamicTable. Each category is represented by one DynamicTable stored in the parent group. This attribute should be used to specify an order of categories and the category names must match the names of the corresponding DynamicTable in the group.

dynamictable: (DynamicTable) A DynamicTable representing a particular category for columns in the AlignedDynamicTable parent container. The table MUST be aligned with (i.e., have the same number of rows) as all other DynamicTables stored in the AlignedDynamicTable parent container. The name of the category is given by the name of the DynamicTable and its description by the description attribute of the DynamicTable.

Tip

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