hotstepper.Steps.clip

Steps.clip(lbound=None, ubound=None)

Clip the steps between lower and upper limits, this function is equivalent to taking a slice of the steps and returning a new steps object only containing data between the clip boundries. The boundry values provided may or may not be returned, as the closest step key value within the specificied range will form the new boundry.

Note

Note This function will preserve the step values at the clip boundries, if you wish to zero out values beyond the boundries, please use the clamp 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.

See also

Steps.clamp