spiketools.plts.spatial.create_heatmap_title¶

spiketools.plts.spatial.create_heatmap_title(label, data, stat=None, p_val=None)[source]¶

Create a standardized title for an heatmap, listing the data range.

Parameters:

labelstr: Label to add to the beginning of the title.
data2d array: The array of data that is plotted, used to compute the data range.
stat, p_valfloat, optional: A statistical test value and p statistic to report related to the heatmap.

Returns: