nctoolkit.DataSet.rolling_max

DataSet.rolling_max(window=None, align='right')

rolling_max: Calculate a rolling maximum based on a window

Parameters:

• window (int) – The size of the window for the calculation of the rolling maximum

• align (str) – This determines whether the output time is at the left, centre or right hand side of the time window. Options are “left”, “centre” and “right”

Examples

If you wanted to calculate a rolling maximum with the maximum calculated over every 10 time steps, do the following:

>>> ds.rolling_max(10)