mne_nirs.visualisation.plot_glm_group_topo#

mne_nirs.visualisation.plot_glm_group_topo(inst, statsmodel_df, value='Coef.', axes=None, threshold=False, *, vlim=(None, None), vmin=None, vmax=None, cmap=None, sensors=True, res=64, sphere=None, colorbar=True, names=False, show_names=None, extrapolate='local', image_interp='cubic')[source]#

Plot topomap of NIRS group level GLM results.

Parameters:
instinstance of Info or Raw

Raw data or info structure used to generate the GLM results.

statsmodel_dfDataFrame

Dataframe created from a statsmodel summary.

valueString

Which column in the statsmodel_df to use in the topo map.

axesinstance of Axes | None

The axes to plot to. If None, the current axes will be used.

thresholdBool

If threshold is true, all values with P>|z| greater than 0.05 will be set to zero.

vlimtuple of length 2

Colormap limits to use. If a tuple of floats, specifies the lower and upper bounds of the colormap (in that order); providing None for either entry will set the corresponding boundary at the min/max of the data (separately for each topomap).

vminfloat | None

Deprecated, use ‘vlim’ instead.

vmaxfloat | None

Deprecated, use ‘vlim’ instead.

cmapmatplotlib colormap | None

Colormap to use. If None, ‘Reds’ is used for all positive data, otherwise defaults to ‘RdBu_r’.

sensorsbool | str

Add markers for sensor locations to the plot. Accepts matplotlib plot format string (e.g., ‘r+’ for red plusses). If True (default), circles will be used.

resint

The resolution of the topomap image (n pixels along each side).

spherenumbers

As specified in mne.

colorbarbool

Should a colorbar be plotted.

nameslist of str

The channel names to display.

show_namesbool

Deprecated, use names instead.

extrapolatestr

Type of extrapolation for image.

image_interpstr

Type of interpolation for image.

Returns:
figfigure

Figure with topographic representation of statsmodel_df value.

Examples using mne_nirs.visualisation.plot_glm_group_topo#

Group Level GLM Analysis

Group Level GLM Analysis