MeaningsTable

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

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

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

MEANINGSTABLE - A table to store information about the meanings of values in a linked VectorData object. All possible values of the linked VectorData object should be present in the ‘value’ column of this table, even if the value is not observed in the data. Additional columns may be added to store additional metadata about each value. The name of the MeaningsTable should correspond to the name of the linked VectorData object with a “_meanings” suffix. e.g., if the linked VectorData object is named “stimulus_type”, the corresponding MeaningsTable should be named “stimulus_type_meanings”.

Required Properties*:: colnames, description, id, meaning, target, value

Constructor Summary

MeaningsTable(varargin)

MEANINGSTABLE - Constructor for MeaningsTable

Syntax:

meaningsTable = types.hdmf_common.MEANINGSTABLE() creates a MeaningsTable object with unset property values.

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

Input Arguments (Name-Value Arguments):

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.
id (ElementIdentifiers) - Array of unique identifiers for the rows of this dynamic table.
meaning (VectorData) - The meaning of the value in the linked VectorData object.
meanings_tables (MeaningsTable) - MeaningsTable objects that provide meanings for values in VectorData columns within this DynamicTable. Tables should be named according to the column they provide meanings for with a “_meanings” suffix. e.g., if a VectorData column is named “stimulus_type”, the corresponding MeaningsTable should be named “stimulus_type_meanings”.
target (VectorData) - Link to the VectorData object for which this table provides meanings.
value (VectorData) - The value of a row in the linked VectorData object.
vectordata (VectorData) - Vector columns, including index columns, of this dynamic table.

Output Arguments:

meaningsTable (types.hdmf_common.MeaningsTable) - A MeaningsTable object

Property Summary

meaning: REQUIRED (VectorData) The meaning of the value in the linked VectorData object.

target: REQUIRED (VectorData) Link to the VectorData object for which this table provides meanings.

value: REQUIRED (VectorData) The value of a row in the linked VectorData object.

Tip

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