mne_denoise.viz.plot_time_frequency_mask#

mne_denoise.viz.plot_time_frequency_mask(mask, times, freqs, title='Time-Frequency Mask', ax=None, show=True, fname=None)[source]#

Visualize a time-frequency mask matrix.

Parameters:
maskarray-like of shape (n_freqs, n_times)

Time-frequency weights.

timesarray-like of shape (n_times,)

Time axis coordinates.

freqsarray-like of shape (n_freqs,)

Frequency axis coordinates.

titlestr

Panel title.

axmatplotlib.axes.Axes | None

Target axes. If None, create a new figure and axes.

showbool

If True, display the figure.

fnamepath-like | None

Optional output path used to save the figure.

Returns:
figmatplotlib.figure.Figure

Figure handle.

Raises:
ValueError

If dimensions of mask, times, and freqs are inconsistent.