braindecode.preprocessing.RenameChannels#

class braindecode.preprocessing.RenameChannels(mapping, allow_duplicates=False, *, on_missing='raise', verbose=None)[source]#

Braindecode preprocessor wrapper for rename_channels().

Rename channels.

Parameters:

  • info (mne.Info) – The mne.Info object with information about the sensors and methods of measurement. Note: modified in place.

  • mapping (dict | callable) –

    A dictionary mapping the old channel to a new channel name e.g. {'EEG061' : 'EEG161'}. Can also be a callable function that takes and returns a string.

    Changed in version 0.10.0: Support for a callable function.

  • allow_duplicates (bool) –

    If True (default False), allow duplicates, which will automatically be renamed with -N at the end.

    Added in version 0.22.0.

  • on_missing ('raise' | 'warn' | 'ignore') –

    Can be 'raise' (default) to raise an error, 'warn' to emit a warning, or 'ignore' to ignore when entries in ch_names are not present in the raw instance.

    Added in version 0.23.0.

    Added in version 1.11.0.

  • verbose (bool | str | int | None) – Control verbosity of the logging output. If None, use the default verbosity level. See the logging documentation and mne.verbose() for details. Should only be passed as a keyword argument.

See also

mne.channels.equalize_channels
mne.channels.unify_bad_channels
mne.channels.combine_channels
On this page