This documentation is for development version 0.18.dev0.

mne.viz.plot_ica_overlay

mne.viz.plot_ica_overlay(ica, inst, exclude=None, picks=None, start=None, stop=None, title=None, show=True)[source]

Overlay of raw and cleaned signals given the unmixing matrix.

This method helps visualizing signal quality and artifact rejection.

Parameters:
ica : instance of mne.preprocessing.ICA

The ICA object.

inst : instance of mne.io.Raw or mne.Evoked

The signals to be compared given the ICA solution. If Raw input, The raw data are displayed before and after cleaning. In a second panel the cross channel average will be displayed. Since dipolar sources will be canceled out this display is sensitive to artifacts. If evoked input, butterfly plots for clean and raw signals will be superimposed.

exclude : array-like of int | None (default)

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

picks : str | list | slice | None

Channels to include. Slices and lists of integers will be interpreted as channel indices. In lists, channel type strings (e.g., ['meg', 'eeg']) will pick channels of those types, channel name strings (e.g., ['MEG0111', 'MEG2623'] will pick the given channels. Can also be the string values “all” to pick all channels, or “data” to pick data channels. None (default) will pick all channels that were included during fitting.

start : int

X-axis start index. If None from the beginning.

stop : int

X-axis stop index. If None to the end.

title : str

The figure title.

show : bool

Show figure if True.

Returns:
fig : instance of Figure

The figure.