xarray.core.rolling.DatasetRolling

class xarray.core.rolling.DatasetRolling(obj, windows, min_periods=None, center=False, keep_attrs=None)
__init__(obj, windows, min_periods=None, center=False, keep_attrs=None)

Moving window object for Dataset. You should use Dataset.rolling() method to construct this object instead of the class constructor.

Parameters

  • obj (Dataset) – Object to window.

  • windows (mapping of hashable to int) – A mapping from the name of the dimension to create the rolling exponential window along (e.g. time) to the size of the moving window.

  • min_periods (int, default: None) – Minimum number of observations in window required to have a value (otherwise result is NA). The default, None, is equivalent to setting min_periods equal to the size of the window.

  • center (bool or mapping of hashable to bool, default: False) – Set the labels at the center of the window.

Returns

rolling

Return type

type of input argument

See also

Dataset.rolling, DataArray.rolling, Dataset.groupby, DataArray.groupby

Methods

__init__(obj, windows[, min_periods, …])

Moving window object for Dataset.

argmax([keep_attrs])

Reduce this object’s data windows by applying argmax along its dimension.

argmin([keep_attrs])

Reduce this object’s data windows by applying argmin along its dimension.

construct([window_dim, stride, fill_value, …])

Convert this rolling object to xr.Dataset, where the window dimension is stacked as a new dimension

count([keep_attrs])

Reduce this object’s data windows by applying count along its dimension.

max([keep_attrs])

Reduce this object’s data windows by applying max along its dimension.

mean([keep_attrs])

Reduce this object’s data windows by applying mean along its dimension.

median([keep_attrs])

Reduce this object’s data windows by applying median along its dimension.

min([keep_attrs])

Reduce this object’s data windows by applying min along its dimension.

prod([keep_attrs])

Reduce this object’s data windows by applying prod along its dimension.

reduce(func[, keep_attrs])

Reduce the items in this group by applying func along some dimension(s).

std([keep_attrs])

Reduce this object’s data windows by applying std along its dimension.

sum([keep_attrs])

Reduce this object’s data windows by applying sum along its dimension.

var([keep_attrs])

Reduce this object’s data windows by applying var along its dimension.

Attributes

center

dim

keep_attrs

min_periods

obj

rollings

window