hotstepper.Steps.step

Steps.step(xdata, process_input=True)

This is a mathematical function definition of the Steps object, this is a dynamically created formula representation that can be passed an array of values to evaluate the steps function at.

Parameters

• xdata (array_like(int, float, datetime)) – The values the steps function is the be evaluated at using the assigned mathematical basis function.

• process_input (bool, Optional) – Indicate if the input data needs processing, to convert datetimes to floats for calculation. Primarily used internally to avoid converting input data twice.

Returns

The values of the cummulative steps function evaluated at the provided input (x axis) values.

Return type

array

See also

fast_step, smooth_step