mne_icalabel.annotation.write_components_tsv

mne_icalabel.annotation.write_components_tsv(ica, fname)

Write channels tsv file for ICA components.

Will create an accompanying JSON sidecar to explain the additional columns created in the channels tsv file for the ICA component labeling.

Parameters:

icaICA

An instance of the fitted ICA.

fnamestr | Path

The output filename.

Notes

Components are stored in a .tsv file essentially in the same manner as channels.tsv files for BIDS-EEG data. For more information, see the BIDS specification for EEG channels metadata.

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.