xarray.core.rolling.DatasetCoarsen

class xarray.core.rolling.DatasetCoarsen(obj, windows, boundary, side, coord_func, keep_attrs)
__init__(self, obj, windows, boundary, side, coord_func, keep_attrs)

Moving window object.

Parameters

  • obj (Dataset or DataArray) – Object to window.

  • windows (A mapping from a dimension name to window size) –

    dimstr

    Name of the dimension to create the rolling iterator along (e.g., time).

    windowint

    Size of the moving window.

  • boundary ('exact' | 'trim' | 'pad') – If ‘exact’, a ValueError will be raised if dimension size is not a multiple of window size. If ‘trim’, the excess indexes are trimed. If ‘pad’, NA will be padded.

  • side ('left' or 'right' or mapping from dimension to 'left' or 'right') –

  • coord_func (mapping from coordinate name to func.) –

Returns

Return type

coarsen

Methods

__init__(self, obj, windows, boundary, side, …)

Moving window object.

all(self, \*\*kwargs)

Reduce this DatasetCoarsen’s data by applying all along some dimension(s).

any(self, \*\*kwargs)

Reduce this DatasetCoarsen’s data by applying any along some dimension(s).

argmax(self, \*\*kwargs)

Reduce this DatasetCoarsen’s data by applying argmax along some dimension(s).

argmin(self, \*\*kwargs)

Reduce this DatasetCoarsen’s data by applying argmin along some dimension(s).

count(self, \*\*kwargs)

Reduce this DatasetCoarsen’s data by applying count along some dimension(s).

max(self, \*\*kwargs)

Reduce this DatasetCoarsen’s data by applying max along some dimension(s).

mean(self, \*\*kwargs)

Reduce this DatasetCoarsen’s data by applying mean along some dimension(s).

median(self, \*\*kwargs)

Reduce this DatasetCoarsen’s data by applying median along some dimension(s).

min(self, \*\*kwargs)

Reduce this DatasetCoarsen’s data by applying min along some dimension(s).

prod(self, \*\*kwargs)

Reduce this DatasetCoarsen’s data by applying prod along some dimension(s).

std(self, \*\*kwargs)

Reduce this DatasetCoarsen’s data by applying std along some dimension(s).

sum(self, \*\*kwargs)

Reduce this DatasetCoarsen’s data by applying sum along some dimension(s).

var(self, \*\*kwargs)

Reduce this DatasetCoarsen’s data by applying var along some dimension(s).

Attributes

boundary

coord_func

keep_attrs

obj

side

trim_excess

windows