postprocessor.routines.heatmap.heatmap¶
- heatmap(trace_df, trace_name, buddings_df=None, cmap=<matplotlib.colors.LinearSegmentedColormap object>, unit_scaling=1, xtick_step=60, scale=True, robust=True, xlabel='Time (min)', ylabel='Cell', cbarlabel='Normalised fluorescence (AU)', plot_title='', ax=None, cbar_ax=None)[source]¶
Draw heatmap from an array of time series of traces
- Parameters
- trace_dfpandas.DataFrame
Time series of traces (rows = cells, columns = time points).
- trace_namestring
Name of trace being plotted, e.g. ‘flavin’.
- buddings_dfpandas.DataFrame
Birth mask (rows = cells, columns = time points). Elements should be 0 or 1.
- cmapmatplotlib ColorMap
Colour map for heatmap.
- unit_scalingint or float
Unit scaling factor, e.g. 1/60 to convert minutes to hours.
- xtick_stepint or float
Interval length, in unit time, to draw x axis ticks.
- scalebool
Whether to use standard scaler to scale the trace time series.
- robustbool
If True, the colour map range is computed with robust quantiles instead of the extreme values.
- xlabelstring
x axis label.
- ylabelstring
y axis label.
- cbarlabelstring
Colour bar label.
- plot_titlestring
Plot title.
- axmatplotlib Axes
Axes in which to draw the plot, otherwise use the currently active Axes.
- cbar_axmatplotlib Axes
Axes in which to draw the colour bar, otherwise take space from the main Axes.
- Returns
- axmatplotlib Axes
Axes object with the heatmap.
Examples
FIXME: Add docs.