xarray.core.rolling.DataArrayCoarsen.reduce

xarray.core.rolling.DataArrayCoarsen.reduce#

DataArrayCoarsen.reduce(func, keep_attrs=None, **kwargs)[source]#

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

Parameters

  • func (callable()) – Function which can be called in the form func(x, axis, **kwargs) to return the result of collapsing an np.ndarray over the coarsening dimensions. It must be possible to provide the axis argument with a tuple of integers.

  • keep_attrs (bool, default: None) – If True, the attributes (attrs) will be copied from the original object to the new one. If False, the new object will be returned without attributes. If None uses the global default.

  • **kwargs (dict) – Additional keyword arguments passed on to func.

Returns

reduced (DataArray) – Array with summarized data.

Examples

>>> da = xr.DataArray(np.arange(8).reshape(2, 4), dims=("a", "b"))
>>> coarsen = da.coarsen(b=2)
>>> coarsen.reduce(np.sum)
<xarray.DataArray (a: 2, b: 2)> Size: 32B
array([[ 1,  5],
       [ 9, 13]])
Dimensions without coordinates: a, b
Contents