max¶
- earthkit.transforms.ensemble.max(*args: Any, **kwargs: Any) Dataset | DataArray[source]¶
Calculate the ensemble maximum.
- Parameters:
dataarray (xarray.DataArray | xarray.Dataset) – The DataArray over which to calculate the ensemble maximum. Must contain an ensemble dimension.
dim (str, optional) – Name of the ensemble dimension in the data object, default behaviour is to detect the ensemble dimension from the input object.
*args – Additional arguments and keyword arguments to pass to the underlying reduce function.
**kwargs – Additional arguments and keyword arguments to pass to the underlying reduce function.
- Returns:
Data reduced to the ensemble maximum.
- Return type: