mne_denoise.viz.plot_harmonic_attenuation#

mne_denoise.viz.plot_harmonic_attenuation(freqs_before, gm_before, cleaned_psds, harmonics_hz, subject='', series_order=None, series_colors=None, series_labels=None, title=None, fname=None, show=True)[source]#

Plot grouped per-harmonic attenuation bars for line-noise studies.

Parameters:
freqs_beforearray-like

Frequency axis of the reference PSD.

gm_beforearray-like

Reference geometric-mean PSD.

cleaned_psdsdict[str, tuple[array-like, array-like]]

Mapping from series name to (freqs, psd) after denoising.

harmonics_hzarray-like of float

Harmonic frequencies to evaluate.

subjectstr

Optional subject label included in default title.

series_orderlist[str] | None, default=None

Plotting order for series. If None, keys from cleaned_psds are used.

series_colorsdict | None, default=None

Optional color overrides keyed by series name.

series_labelsdict | None, default=None

Optional display-label overrides keyed by series name.

titlestr | None, default=None

Custom axes title.

fnamepath-like | None

Optional output path.

showbool

Whether to display the figure.

Returns:
figmatplotlib.figure.Figure

Figure handle.