mne_icalabel.annotation.mark_component

mne_icalabel.annotation.mark_component(component, fname, method, label, author, strict_label=True)

Mark a component with a label.

Parameters:

componentint

The component to mark.

fnameUnion[str, Path]

The filename for the BIDS filepath.

methodstr

The method to use. Must be ‘manual’, or one of [‘iclabel’].

labelstr

The label of the ICA component. Must be one of [‘brain’, ‘muscle artifact’, ‘eye blink’, ‘heart beat’, ‘line noise’, ‘channel noise’, ‘other’].

authorstr

The annotating author.

strict_labelbool

Whether to raise an error if label is not an accepted value. Default is True.

Notes

Storage of ICA annotations as a .tsv file is currently experimental in the context of BIDS-EEG Derivatives. The API and functionality is subject to change as the community converges on the specification of BIDS-Derivatives.