mne_denoise.viz.plot_denoising_summary

mne_denoise.viz.plot_denoising_summary(inst_before, inst_after, *, info, times, title='Denoising Summary', show=True, fname=None)

Plot a generic denoising diagnostics dashboard.

Parameters:

inst_beforeMNE object | ndarray

Signal before denoising. Supported array shapes are (n_channels, n_times) and (n_epochs, n_channels, n_times). MNE Raw/Epochs/Evoked inputs are also accepted.

inst_afterMNE object | ndarray

Signal after denoising with matching channel and time dimensions.

infomne.Info

Channel info used for the power-ratio map panel.

timesarray-like of shape (n_times,)

Explicit time axis for GFP traces.

titlestr

Figure title.

showbool

Whether to display the figure.

fnamepath-like | None

Optional output path.

Returns:

figmatplotlib.figure.Figure

Figure handle.

Raises:

ValueError

If times is not 1D or does not match the GFP length.