staircase.Stairs.clip

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

Returns a copy of self which is zero-valued everywhere outside of [lower, upper)

Parameters:
  • lower (int, float or pandas.Timestamp) – lower bound of the interval
  • upper (int, float or pandas.Timestamp) – upper bound of the interval
Returns:

Returns a copy of self which is zero-valued everywhere outside of [lower, upper)

Return type:

Stairs

Examples

>>> fig, axes = plt.subplots(nrows=1, ncols=2, figsize=(12,5))
>>> s1.plot(axes[0])
>>> s1.clip(2,4).plot(axes[1])
>>> s1.clip(2,4).mean()
0.5
../_images/staircase-Stairs-clip-1.png