hotstepper.Steps.read_array¶

classmethod Steps.read_array(start=None, end=None, weight=None, use_datetime=False, convert_delta=False)¶

Read arrays of values for start, end and weight values that represent either the cummulative value of the data steps or the direct step values seperately, indexed by the start and possibly end arrays.

Parameters

start (array_like) – An array of step start location values.
end (array_like, Optional) – An array of step end location values.
weight (array_like, Optional) – An array of step weight values, if these are not provided, a value of 1 will be assigned for each row entry.
use_datetime (bool, Opyional) – Assume start and end fields are of datetime format (Numpy.datetime64,datetime or Pandas.Timestamp).
convert_delta (bool, Optional) – Assume weight values are individual step weights (default), or convert values by performing a delta between adjacent values. The data is assumed to be sorted by the provided start values.

Returns

Return type

Steps