braindecode.preprocessing.SetAnnotations#

class braindecode.preprocessing.SetAnnotations(annotations, emit_warning=True, on_missing='raise', *, verbose=None)[source]#

Braindecode preprocessor wrapper for set_annotations().

Setter for annotations.

This setter checks if they are inside the data range.

Parameters:

  • annotations (instance of mne.Annotations | None) – Annotations to set. If None, the annotations is defined but empty.

  • emit_warning (bool) – Whether to emit warnings when cropping or omitting annotations. The default is True.

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

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

Returns:

self (instance of Raw) – The raw object with annotations.

On this page