DynamicTableRegion

See also:

Format Specification or Source Specification for DynamicTableRegion.

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

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

DYNAMICTABLEREGION - DynamicTableRegion provides a link from one table to an index or region of another. The table attribute is a link to another DynamicTable, indicating which table is referenced, and the data is int(s) indicating the row(s) (0-indexed) of the target array. DynamicTableRegion`s can be used to associate rows with repeated meta-data without data duplication. They can also be used to create hierarchical relationships between multiple `DynamicTable`s. `DynamicTableRegion objects may be paired with a VectorIndex object to create ragged references, so a single cell of a DynamicTable can reference many rows of another DynamicTable.

Required Properties*:

data, description, table

Constructor Summary
DynamicTableRegion(varargin)

DYNAMICTABLEREGION - Constructor for DynamicTableRegion

Syntax:

dynamicTableRegion = types.hdmf_common.DYNAMICTABLEREGION() creates a DynamicTableRegion object with unset property values.

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

Input Arguments (Name-Value Arguments):

  • data (int8) - Data property for dataset class (DynamicTableRegion)

  • description (char) - Description of what this table region points to.

  • resolution (double) - NOTE: this is a special value for compatibility with the Units table and is only written to file when detected to be in that specific HDF5 Group. The smallest possible difference between two spike times. Usually 1 divided by the acquisition sampling rate from which spike times were extracted, but could be larger if the acquisition time series was downsampled or smaller if the acquisition time series was smoothed/interpolated and it is possible for the spike time to be between samples.

  • sampling_rate (single) - NOTE: this is a special value for compatibility with the Units table and is only written to file when detected to be in that specific HDF5 Group. Must be Hertz

  • table (Object reference to DynamicTable) - Reference to the DynamicTable object that this region applies to.

Output Arguments:
Property Summary
table

REQUIRED (Object reference to DynamicTable) Reference to the DynamicTable object that this region applies to.

Method Summary
validate_table(val)

Reference to type DynamicTable

Tip

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