brain_pipe.preprocessing.brain.rereference.CommonAverageRereference

class CommonAverageRereference(data_key: str = 'data', axis: int = 0, *args, **kwargs: Any)

Bases: PipelineStep

Re-reference multivariate data to the common average of all channels.

__init__(data_key: str = 'data', axis: int = 0, *args, **kwargs: Any) → None

Create a new CommonAverageRereference instance.

Parameters:

data_key (str) – The key of the EEG data in the data dict.

Methods

__init__([data_key, axis])	Create a new CommonAverageRereference instance.
parse_dict_keys(key[, name, ...])	Parse a key or a sequence of keys.

parse_dict_keys(key: str | Sequence[str] | Mapping[str, str], name='key', require_ordered_dict=False) → OrderedDict[str, str]

Parse a key or a sequence of keys.

Parameters:

• key (Union[str, Sequence[str], Mapping[str,str]]) – A key or a sequence of keys.

• name (str) – The name of the key. Used for error messages.

• require_ordered_dict (bool) – If True, the key must be an OrderedDict. If False, the key can also be an ordinary dict.

Returns:

A mapping of input keys to output keys.

Return type:

OrderedDict[str, str]

Raises:

TypeError – If the key is not a string, a sequence of strings or a mapping of strings. If the key is a mapping but require_ordered_dict is True and the mapping is not an OrderedDict.