mne_icalabel.annotation.mark_component#
- mne_icalabel.annotation.mark_component(component, fname, method, label, author, strict_label=True)[source]#
Mark a component with a label.
- Parameters:
- component
int
The component to mark.
- fname
Union
[str
,Path
] The filename for the BIDS filepath.
- method
str
The method to use. Must be ‘manual’, or one of [‘iclabel’].
- label
str
The label of the ICA component. Must be one of [‘brain’, ‘muscle artifact’, ‘eye blink’, ‘heart beat’, ‘line noise’, ‘channel noise’, ‘other’].
- author
str
The annotating author.
- strict_label
bool
Whether to raise an error if
label
is not an accepted value. Default is True.
- component
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.