hotstepper.Steps.series

Steps.series(xdata=None, ydata=None)

A convenience function to either return the internal steps data in a Pandas Series object with the steps keys as the index or convert a provided 2-D set of data into a Pandas Series.

The Pandas Series has a number of helpful methods and features and the ability to quickly convert 2-D data into a Pandas Series allows for fast iteration during analysis.

Parameters

• xdata (array_like, tuple, Optional) – A 1-D array representing the data to use as the index of the Pandas Series or, A tuple representing 2 x 1-D arrays to use as the index and values of the Pandas Series.

• ydata (array_like, Optional) – A 1-D array represeting the data to use as the values of the Pandas Series. If no xdata is provided, an integer based index will be generated across the length of the provided ydata.

Returns

Return type

Pandas.Series