FrequencyBandsTable

See also:

Format Specification or Source Specification for FrequencyBandsTable.

class types.core.FrequencyBandsTable(varargin)[source]

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

FREQUENCYBANDSTABLE - Table for describing the bands that DecompositionSeries was generated from. There should be one row in this table for each band.

Required Properties*:

band_limits, band_name, colnames, description, id

Constructor Summary
FrequencyBandsTable(varargin)

FREQUENCYBANDSTABLE - Constructor for FrequencyBandsTable

Syntax:

frequencyBandsTable = types.core.FREQUENCYBANDSTABLE() creates a FrequencyBandsTable object with unset property values.

frequencyBandsTable = types.core.FREQUENCYBANDSTABLE(Name, Value) creates a FrequencyBandsTable object where one or more property values are specified using name-value pairs.

Input Arguments (Name-Value Arguments):

  • band_limits (VectorData) - Low and high limit of each band in Hz. If it is a Gaussian filter, use 2 SD on either side of the center.

  • band_mean (VectorData) - The mean Gaussian filters, in Hz.

  • band_name (VectorData) - Name of the band, e.g. theta.

  • band_stdev (VectorData) - The standard deviation of Gaussian filters, in Hz.

  • 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.

  • 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”.

  • vectordata (VectorData) - Vector columns, including index columns, of this dynamic table.

Output Arguments:
Property Summary
band_limits

REQUIRED (VectorData) Low and high limit of each band in Hz. If it is a Gaussian filter, use 2 SD on either side of the center.

band_mean

(VectorData) The mean Gaussian filters, in Hz.

band_name

REQUIRED (VectorData) Name of the band, e.g. theta.

band_stdev

(VectorData) The standard deviation of Gaussian filters, in Hz.

Tip

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