staircase.Stairs.percentile_stairs

Stairs.percentile_stairs(lower=-inf, upper=inf)

Calculates a percentile function (and returns a corresponding Stairs instance)

This method can be used for efficiency gains if substituting for multiple calls to percentile() with the same lower and upper parameters

Parameters:
  • lower (int, float or pandas.Timestamp, optional) – lower bound of the interval on which to perform the calculation
  • upper (int, float or pandas.Timestamp, optional) – upper bound of the interval on which to perform the calculation
Returns:

An instance representing a percentile function

Return type:

Stairs

Examples

>>> fig, axes = plt.subplots(nrows=1, ncols=2, figsize=(12,5))
>>> s2.plot(axes[0])
>>> axes[0].set_title("s2")
>>> s2_percentiles = s2.percentile_stairs()
>>> s2_percentiles.plot(axes[1])
>>> axes[0].set_title("s2 percentiles")
>>> s2_percentiles(55)
0.0
>>> s2_percentiles(75)
0.5
../_images/staircase-Stairs-percentile_stairs-1.png