xarray.NamedArray.reduce

NamedArray.reduce(func, dim=None, axis=None, keepdims=False, **kwargs)

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

Parameters:

• func (callable()) – Function which can be called in the form func(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 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 func(x) without an axis argument).

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

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

Returns:

reduced (Array) – Array with summarized data and the indicated dimension(s) removed.