hotstepper.Steps.clamp¶

Steps.clamp(lbound=None, ubound=None)¶

Clamp the steps between lower and upper limits, this function is equivalent to zeroing out the steps beyond the lower and upper limits. The returned steps will contain the specified lower and upper limit keys inclusively.

Note

Note This function will not preserve the step values at the clamp boundries, if you wish to preserve the values beyond the boundries, please use the clip function.

Parameters

lbound (int, float, datetime_like, Optional) – The lower step key boundry (x axis value) of the returned steps object, the exact start key of the return object will be the key value = lbound.
ubound (int, float, datetime_like, Optional) – The upper step key boundry (x axis value) of the returned steps object, the exact start key of the return object will be the key value = ubound.