pycrostates.viz.plot_cluster_centers

pycrostates.viz.plot_cluster_centers(cluster_centers, info, cluster_names=None, axes=None, show_gradient=False, gradient_kwargs={'color': 'black', 'linestyle': '-', 'marker': 'P'}, *, block=False, show=None, verbose=None, **kwargs)

Create topographic maps for cluster centers.

Parameters:

cluster_centersarray (n_clusters, n_channels)

Fitted clusters, i.e. the microstates maps.

infoInfo | ChInfo

Info instance with a montage used to plot the topographic maps.

cluster_nameslist | None

Name of the clusters.

axesAxes | None

Either None to create a new figure or axes (or an array of axes) on which the topographic map should be plotted. If the number of microstates maps to plot is ≥ 1, an array of axes of size n_clusters should be provided.

show_gradientbool

If True, plot a line between channel locations with highest and lowest values.

gradient_kwargsdict

Additional keyword arguments passed to matplotlib.axes.Axes.plot() to plot gradient line.

blockbool

Whether to halt program execution until the figure is closed.

showbool | None

If True, the figure is shown. If None, the figure is shown if the matplotlib backend is interactive.

verboseint | str | bool | None

Sets the verbosity level. The verbosity increases gradually between "CRITICAL", "ERROR", "WARNING", "INFO" and "DEBUG". If None is provided, the verbosity is set to "WARNING". If a bool is provided, the verbosity is set to "WARNING" for False and to "INFO" for True.

**kwargs

Additional keyword arguments are passed to mne.viz.plot_topomap().

Returns:

figFigure

Matplotlib figure(s) on which topographic maps are plotted.