transfreq.viz.plot_channels

transfreq.viz.plot_channels(tfbox, ch_locs, mode=None, showfig=True, subfig=None)

Plot clustered channels on head topomap

Parameters:

tfbox: dictionary

output of either create_cluster, compute_transfreq_manual or compute_transfreq

ch_locs: array, shape (N_channels, 3)

channels locations (unit of measure: mm),

mode: None, ‘1d’, ‘2d’ (default None)

mode to be used for plotting. If ‘1d’ the ratio between alpha and theta coefficients will be plotted. If ‘2d’ alpha and theta coefficients will be plotted on the plane. If None (default) and the method contained in tfbox is 1, 2, 3 of 4 the mode will be set automatically.

showfig: bool (default True)

if True figure will be showed, if False figure will not be showed

ax: instance of Axes | None

Axes to plot into. If None, axes will be created.

Returns:

fig: instance of Figure

Figure representing the clustered channels on head topomap