xarray.DataArray.reduce#

DataArray.reduce(func, dim=None, *, axis=None, keep_attrs=None, keepdims=False, **kwargs)[source]#

Reduce this array by applying func along some dimension(s).

Parameters:

  • func (callable()) – Function which can be called in the form f(x, axis=axis, **kwargs) to return the result of reducing an np.ndarray over an integer valued axis.

  • dim ("...", str, Iterable of Hashable or None, optional) – Dimension(s) over which to apply func. By default func is applied over all dimensions.

  • axis (int or sequence of int, optional) – Axis(es) over which to repeatedly apply func. Only one of the ‘dim’ and ‘axis’ arguments can be supplied. If neither are supplied, then the reduction is calculated over the flattened array (by calling f(x) without an axis argument).

  • keep_attrs (bool or None, optional) – If True, the variable’s attributes (attrs) will be copied from the original object to the new one. If False (default), the new object will be returned without attributes.

  • keepdims (bool, default: False) – If True, the dimensions which are reduced are left in the result as dimensions of size one. Coordinates that use these dimensions are removed.

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

Returns:

reduced (DataArray) – DataArray with this object’s array replaced with an array with summarized data and the indicated dimension(s) removed.