hotstepper.Steps.fast_step

Steps.fast_step(xdata, process_input=True, side='right')

This will evaluate the cummulative steps function at the provided input values. This function ignores the assigned basis and performs some numpy trickery to improve performance.

Note

This function will ignore the assigned basis and evaluate the cummulative function directly, to ensure the assigned basis is used, please use the step function.

Parameters

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

  • 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.

  • side ({'right', 'left'}, Optional) – Location to evaluate the steps function relative to the step location. Default is ‘right’, which means the step assumes the weight value on and after the step key value.

Returns

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

Return type

array

See also

step, smooth_step