mne_denoise.viz.plot_component_summary

mne_denoise.viz.plot_component_summary(estimator, data=None, info=None, picks=None, times=None, sfreq=None, n_components=None, psd_fmax=None, show=True, plot_ci=True, fname=None)

Plot a compact per-component summary dashboard.

Parameters:

estimatorobject

Fitted estimator exposing component patterns and a transform/source API.

datamne.io.BaseRaw | mne.BaseEpochs | ndarray | None

Input data used to compute component sources when they are not cached.

infomne.Info | None

Sensor metadata for topomap rendering.

picksarray-like of int | None

Channel indices used for topomap rendering. If None, the pattern panel uses a text placeholder instead of topomaps.

timesarray-like of shape (n_times,) | None

Explicit time coordinates for source time-course panels. If None, sample indices are used.

sfreqfloat | None

Sampling frequency used for PSD computation when info is not available. Required if info cannot be resolved.

n_componentsint | sequence of int | None

Components to plot. If None, plot up to five components.

psd_fmaxfloat | None

Maximum frequency (Hz) shown in the PSD column. If None, defaults to min(100, sfreq / 2) to preserve previous behavior.

showbool, default=True

If True, show the figure.

plot_cibool, default=True

If True and sources are epoched, overlay a 95% CI band based on SEM.

fnamepath-like | None

Optional output path used to save the figure.

Returns:

figmatplotlib.figure.Figure

Figure handle.

Raises:

ValueError

If no components are selected, if psd_fmax is not positive, if times length mismatches source length, or if picks is provided without valid info. Also raised when neither info nor sfreq is provided.