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:

  • mask (array-like of shape (n_freqs, n_times)) – Time-frequency weights.

  • times (array-like of shape (n_times,)) – Time axis coordinates.

  • freqs (array-like of shape (n_freqs,)) – Frequency axis coordinates.

  • title (str) – Panel title.

  • ax (matplotlib.axes.Axes | None) – Target axes. If None, create a new figure and axes.

  • show (bool) – If True, display the figure.

  • fname (path-like | None) – Optional output path used to save the figure.

Returns:

fig – Figure handle.

Return type:

matplotlib.figure.Figure

Raises:

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

Examples

>>> import numpy as np
>>> from mne_denoise.viz import plot_time_frequency_mask
>>> mask = np.random.rand(20, 100)
>>> times = np.linspace(0, 2.0, 100)
>>> freqs = np.linspace(1.0, 40.0, 20)
>>> fig = plot_time_frequency_mask(mask, times, freqs, show=False)