xarray.Dataset.reduce¶
-
Dataset.reduce(func, dim=None, keep_attrs=None, keepdims=False, numeric_only=False, allow_lazy=False, **kwargs)¶ Reduce this dataset by applying func along some dimension(s).
- Parameters
- funcfunction
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.
- dimstr or sequence of str, optional
Dimension(s) over which to apply func. By default func is applied over all dimensions.
- keep_attrsbool, optional
If True, the dataset’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.
- keepdimsbool, 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.
- numeric_onlybool, optional
If True, only apply
functo variables with a numeric dtype.- **kwargsdict
Additional keyword arguments passed on to
func.
- Returns
- reducedDataset
Dataset with this object’s DataArrays replaced with new DataArrays of summarized data and the indicated dimension(s) removed.