ElectrodesTable

See also:

Format Specification or Source Specification for ElectrodesTable.

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

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

ELECTRODESTABLE - A table of all electrodes (i.e. channels) used for recording. Introduced in NWB 2.8.0. Replaces the “electrodes” table (neurodata_type_inc DynamicTable, no neurodata_type_def) that is part of NWBFile.

Required Properties*:

colnames, description, group, id, location

Constructor Summary
ElectrodesTable(varargin)

ELECTRODESTABLE - Constructor for ElectrodesTable

Syntax:

electrodesTable = types.core.ELECTRODESTABLE() creates an ElectrodesTable object with unset property values.

electrodesTable = types.core.ELECTRODESTABLE(Name, Value) creates an ElectrodesTable 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.

  • filtering (VectorData) - Description of hardware filtering, including the filter name and frequency cutoffs.

  • group (VectorData) - Reference to the ElectrodeGroup this electrode is a part of.

  • group_name (VectorData) - Name of the ElectrodeGroup this electrode is a part of.

  • id (ElementIdentifiers) - Array of unique identifiers for the rows of this dynamic table.

  • imp (VectorData) - Impedance of the channel, in ohms.

  • location (VectorData) - Location of the electrode (channel). Specify the area, layer, comments on estimation of area/layer, stereotaxic coordinates if in vivo, etc. Use standard atlas names for anatomical regions when possible.

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

  • reference (VectorData) - Description of the reference electrode and/or reference scheme used for this electrode, e.g., “stainless steel skull screw” or “online common average referencing”.

  • rel_x (VectorData) - x coordinate in electrode group. Units should be specified in microns.

  • rel_y (VectorData) - y coordinate in electrode group. Units should be specified in microns.

  • rel_z (VectorData) - z coordinate in electrode group. Units should be specified in microns.

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

  • x (VectorData) - x coordinate of the channel location in the brain (+x is posterior). Units should be specified in microns.

  • y (VectorData) - y coordinate of the channel location in the brain (+y is inferior). Units should be specified in microns.

  • z (VectorData) - z coordinate of the channel location in the brain (+z is right). Units should be specified in microns.

Output Arguments:
Property Summary
filtering

(VectorData) Description of hardware filtering, including the filter name and frequency cutoffs.

group

REQUIRED (VectorData) Reference to the ElectrodeGroup this electrode is a part of.

group_name

(VectorData) Name of the ElectrodeGroup this electrode is a part of.

imp

(VectorData) Impedance of the channel, in ohms.

location

REQUIRED (VectorData) Location of the electrode (channel). Specify the area, layer, comments on estimation of area/layer, stereotaxic coordinates if in vivo, etc. Use standard atlas names for anatomical regions when possible.

reference

(VectorData) Description of the reference electrode and/or reference scheme used for this electrode, e.g., “stainless steel skull screw” or “online common average referencing”.

rel_x

(VectorData) x coordinate in electrode group. Units should be specified in microns.

rel_y

(VectorData) y coordinate in electrode group. Units should be specified in microns.

rel_z

(VectorData) z coordinate in electrode group. Units should be specified in microns.

x

(VectorData) x coordinate of the channel location in the brain (+:attr:x <types.core.ElectrodesTable.x> is posterior). Units should be specified in microns.

y

(VectorData) y coordinate of the channel location in the brain (+:attr:y <types.core.ElectrodesTable.y> is inferior). Units should be specified in microns.

z

(VectorData) z coordinate of the channel location in the brain (+:attr:z <types.core.ElectrodesTable.z> is right). Units should be specified in microns.

Tip

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