staircase.mean

staircase.mean(collection)

Takes a collection of Stairs instances and returns the mean of the corresponding step functions.

Parameters:collection (tuple, list, numpy array, dict or pandas.Series) – The Stairs instances to aggregate using a mean function
Returns:
Return type:Stairs

Examples

>>> import staircase as sc
>>> stair_list = [s1, s2, sc.mean([s1,s2])]
>>> fig, axes = plt.subplots(nrows=1, ncols=3, figsize=(17,5), sharey=True, sharex=True)
>>> for ax, title, stair_instance in zip(axes, ("s1", "s2", "mean(s1,s2)"), stair_list):
...     stair_instance.plot(ax)
...     ax.set_title(title)
../_images/staircase-mean-1.png