postprocessor.routines.boxplot.boxplot

postprocessor.routines.boxplot.boxplot(trace_df, trace_name, unit_scaling=1, box_color='b', xtick_step=60, xlabel='Time (min)', plot_title='', ax=None)

Draw series of boxplots from an array of time series of traces

Draw series of boxplots from an array of time series of traces, showing the distribution of values at each time point over time.

Parameters

trace_dfpandas.DataFrame

Time series of traces (rows = cells, columns = time points).

trace_namestring

Name of trace being plotted, e.g. ‘flavin’.

unit_scalingint or float

Unit scaling factor, e.g. 1/60 to convert minutes to hours.

box_colorstring

matplolib colour string, specifies colour of boxes in boxplot

xtick_stepint or float

Interval length, in unit time, to draw x axis ticks.

xlabelstring

x axis label.

plot_titlestring

Plot title.

axmatplotlib Axes

Axes in which to draw the plot, otherwise use the currently active Axes.

Returns

axmatplotlib Axes

Axes object with the heatmap.

Examples

FIXME: Add docs.