transfreq.viz.plot_clusters

transfreq.viz.plot_clusters(tfbox, mode=None, order='standard', showfig=True, ax=None)

Plot clusters

Parameters:

tfbox: dictionary

output of either create_cluster, compute_transfreq_manual or compute_transfreq

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 or 4 the mode will be set automatically.

order: ‘standard’ or ‘sorted’ (default ‘standard’)

Way to plot the coefficients (only when mode=’1d’ or the methods contained in the tfbox is 1 or 2, otherwise is not considered)

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 clustering