This documentation is for development version 0.18.dev0.

mne.viz.plot_ica_scores

mne.viz.plot_ica_scores(ica, scores, exclude=None, labels=None, axhline=None, title='ICA component scores', figsize=None, show=True)[source]

Plot scores related to detected components.

Use this function to asses how well your score describes outlier sources and how well you were detecting them.

Parameters:
ica : instance of mne.preprocessing.ICA

The ICA object.

scores : array-like of float, shape (n_ica_components,) | list of array

Scores based on arbitrary metric to characterize ICA components.

exclude : array-like of int

The components marked for exclusion. If None (default), ICA.exclude will be used.

labels : str | list | ‘ecg’ | ‘eog’ | None

The labels to consider for the axes tests. Defaults to None. If list, should match the outer shape of scores. If ‘ecg’ or ‘eog’, the labels_ attributes will be looked up. Note that ‘/’ is used internally for sublabels specifying ECG and EOG channels.

axhline : float

Draw horizontal line to e.g. visualize rejection threshold.

title : str

The figure title.

figsize : tuple of int | None

The figure size. If None it gets set automatically.

show : bool

Show figure if True.

Returns:
fig : instance of Figure

The figure object