hotstepper.Steps.plot_rolling_step

Steps.plot_rolling_step(rolling_function=None, window=5, pre_mid_post='mid', ax=None, **kargs)

Plot the result of applying a reduction function to a rolling window across the step values.

Parameters

  • rolling_function (Numpy.ufunc, Optional) – A numpy reduction function to apply to the rolling window across the steps data, for example np.mean, np.max.

  • widnow (int, Optional) – The size of the rolling window to apply across the steps data.

  • pre_mid_post ({'pre','mid','post'}, Optional) – Where to centre the reduction location within the rolling window. Using centre will associate the reduced value with the centre key of the window.

  • ax (Matplotlib.Axes) – The plot axis to create the plot on if being created externally.

  • **kargs – Matplotlib key-value paramters to pass to the plot.

Returns

Return type

Matplotlib.Axes

See also

ecdf_plot, pacf_plot, histogram_plot, summary