convnwb.objects.electrodes.Electrodes

class convnwb.objects.electrodes.Electrodes

Object for collecting electrode information.

__init__()

Initialize Electrodes object.

Methods

__init__()	Initialize Electrodes object.
add_bundle(name, location)	Add a bundle to the object.
add_bundles(names, locations)	Add multiple bundles to the object.
copy()	Return a deepcopy of this object.
data_keys([skip])	Get a list of data keys defined in the electrodes object.
set_placeholder()	Set object information as a placeholder.
to_dataframe()	Return object data as a dataframe.
to_dict()	Convert object data to a dictionary.

Attributes

n_bundles	The number of bundles stored in the object.
n_electrodes_per_bundle

add_bundle(name, location)

Add a bundle to the object.

add_bundles(names, locations)

Add multiple bundles to the object.

copy()

Return a deepcopy of this object.

data_keys(skip=None)

Get a list of data keys defined in the electrodes object.

Parameters:

skipstr or list of str

Name(s) of any data attributes to skip.

Returns:

data_keyslist of str

List of data attributes available in the object.

property n_bundles

The number of bundles stored in the object.

set_placeholder()

Set object information as a placeholder.

to_dataframe()

Return object data as a dataframe.

to_dict()

Convert object data to a dictionary.