visualise_topographical_correlation_map

visualise_topographical_correlation_map(domain, TCM, ax=None, add_cbar=True, colorbar_limit=None, tcm_cmap='RdBu_r', colorbar_label='TCM, $\\Gamma$', TCM_zorder=0, objects_to_plot=False, figure_kwargs={}, visualise_kwargs={})

Visualise a topographical correlation map (TCM) on a given domain.

Parameters:

domainobject

A muspan domain.

TCMarray-like

The topographical correlation map to be visualised.

axmatplotlib.axes.Axes, optional

The axes on which to plot the TCM. If None, a new figure and axes are created. Default is None.

add_cbarbool, optional

If True, add a colorbar. Default is True.

colorbar_limit{None, ‘auto’, int, float}, optional

The limits for the colorbar. If None or ‘auto’, the limits are set to the min and max of TCM. If an int or float, the limits are set to [-abs(colorbar_limit), abs(colorbar_limit)]. Default is None.

tcm_cmapstr, optional

The matplotlib colormap to used for TCM heatmap. Default is ‘RdBu_r’.

colorbar_labelstr, optional

The label for the colorbar. Default is ‘TCM, \(\Gamma\)’.

TCM_zorderint, optional

The z-order for the TCM plot. Default is 10.

objects_to_plotbool, list, tuple, query-like optional

If False, no additional objects are plotted. If a list, tuple, query-like, the objects specified are plotted. Default is False.

figure_kwargsdict, optional

Dictionary of arguments to pass to the plt.figure function, defaults to None.

visualise_kwargsdict, optional

Additional keyword arguments passed to the visualise function.

Returns:

figmatplotlib.figure.Figure

The figure object containing the plot.

axmatplotlib.axes.Axes

The axes object containing the plot.

Raises:

ValueError

If colorbar_limit is a list or tuple not of length 2. If colorbar_limit is not a list, tuple, int, float, or ‘auto’.