mne_denoise.viz.plot_component_patterns#

mne_denoise.viz.plot_component_patterns(estimator, info=None, picks=None, n_components=None, ax=None, show=True, fname=None)[source]#

Plot spatial component patterns.

Parameters:

estimatorobject: Fitted estimator exposing patterns_.
infomne.Info | None: Measurement info used for topomap rendering.
picksarray-like of int | None: Channel indices used for topomap rendering. If None, no topomap is attempted and the function falls back to channel-weight line plots.
n_componentsint | sequence of int | None: Components to plot. If an int, plot the first n_components.
axmatplotlib.axes.Axes | None: Optional target axes. Supported only for the line-plot fallback or when rendering a single topomap.
showbool, default=True: If True, show the figure.
fnamepath-like | None: Optional output path used to save the figure.

Returns:

figmatplotlib.figure.Figure: Figure handle.

Raises:

ValueError: If patterns are not 2D, if no components are selected, or when ax is passed while requesting multiple topomaps. Also raised when picks is provided without valid info.