mvpa2.misc.plot.base.timeseries_boxplot

mvpa2.misc.plot.base.timeseries_boxplot(median, mean=None, std=None, n=None, min=None, max=None, p25=None, p75=None, outlierd=None, segment_sizes=None, **kwargs)

Produce a boxplot-like plot for time series data.

Most statistics that are normally found in a boxplot are supported, but at the same time most of them are also optional. This function performs plotting only. Actual statistics need to be computed elsewhere (see compute_ts_boxplot_stats).

Parameters:

median : array

Median time series. Plotted as a black line.

mean : array or None

Mean time series. If provided in combination with std and n a dark gray shaded area representing +-SEM will be plotted.

std : array or None

Standard deviation time series. If provided in combination with mean and n a dark gray shaded area representing +-SEM will be plotted.

n : array or None

Number of observations per time series sample. If provided in combination with mean and std a dark gray shaded area representing +-SEM will be plotted.

min : array or None

Minimum value time series. If provided in combination with max a light gray shaded area representing the range will be plotted.

max : array or None

Maximum value time series. If provided in combination with min a light gray shaded area representing the range will be plotted.

p25 : array or None

25% percentile time series. If provided in combination with p75 a medium gray shaded area representing the +-25% percentiles will be plotted.

p75 : array or None

75% percentile time series. If provided in combination with p25 a medium gray shaded area representing the +-25% percentiles will be plotted.

outlierd : list(masked array) or None

A list with items corresponding to each data segment. Each item is a masked array (observations x series) with all non-outlier values masked. Outliers are plotted in red color.

segment_sizes : list or None

If provided, each items indicates the size of one element in a consecutive series of data segment. A marker will be be drawn at the border between any two consecutive segments.

**kwargs

Additional keyword arguments that are uniformly passed on to any utilized plotting function.