ElectrodeGroup

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

class types.core.ElectrodeGroup(varargin)[source]

Bases: types.core.NWBContainer, types.untyped.GroupClass

ELECTRODEGROUP - A physical grouping of electrodes, e.g., a shank of an array. An electrode group is typically used to describe electrodes that are physically connected on a single device and are often (but not always) used together for analysis, such as for spike sorting. Note that this is descriptive metadata; electrodes from different groups can still be spike-sorted together if needed.

Required Properties*:: description, device, location

Constructor Summary

ElectrodeGroup(varargin)

ELECTRODEGROUP - Constructor for ElectrodeGroup

Syntax:

electrodeGroup = types.core.ELECTRODEGROUP() creates an ElectrodeGroup object with unset property values.

electrodeGroup = types.core.ELECTRODEGROUP(Name, Value) creates an ElectrodeGroup object where one or more property values are specified using name-value pairs.

Input Arguments (Name-Value Arguments):

description (char) - Description of this electrode group.
device (Device) - Link to the device that was used to record from this electrode group.
location (char) - Location of electrode group. Specify the area, layer, comments on estimation of area/layer, etc. Use standard atlas names for anatomical regions when possible.
position (Table with columns: (single, single, single)) - stereotaxic or common framework coordinates

Output Arguments:

electrodeGroup (types.core.ElectrodeGroup) - An ElectrodeGroup object

Property Summary

description: REQUIRED (char) Description of this electrode group.

device: REQUIRED (Device) Link to the device that was used to record from this electrode group.

location: REQUIRED (char) Location of electrode group. Specify the area, layer, comments on estimation of area/layer, etc. Use standard atlas names for anatomical regions when possible.

position: (Table with columns: (x = single, y = single, z = single)) stereotaxic or common framework coordinates

Tip

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