staircase.Stairs.where#

Stairs.where(other)#

Returns a new step function where self has been ‘inversely masked’ by other.

Note when other is as Stairs instance, is is considered equivalent to its boolean value, that is, the result of Stairs.make_boolean(). As a result any part of the domain where other is not zero-valued, or not defined, will be undefined in the resulting step function.

Also note that .where((a,b)) is equivalent to .where(sc.Stairs().layer(a,b)) but defers to a faster implementation.

Parameters
otherStairs, or tuple

If other is a tuple (a,b) then it is assumed that a < b and that a and b both belong to the domain of the step function represented by self. An exception is when a or b are strings, in which case they are assumed to be pandas.Timestamp and the above conditions apply.

Returns
Stairs

Examples

../../_images/staircase-Stairs-where-1.png
../../_images/staircase-Stairs-where-2.png