earthkit.meteo.stats.fit_gumbel

earthkit.meteo.stats.fit_gumbel(sample: ArrayLike, dim: int) → earthkit.meteo.stats.array.extreme_values.GumbelDistribution

earthkit.meteo.stats.fit_gumbel(sample: xarray.DataArray, dim: str) → earthkit.meteo.stats.array.extreme_values.GumbelDistribution

Gumbel distribution with parameters fitted to a sample of values.

Warning

Experimental API. This function may change or be removed without notice.

Results derived from the fitted distribution will only be meaningful if it is representative of the sample statistics.

Parameters:

• sample (array-like or xarray.DataArray) – Sample values.

• dim (str or int) – Dimension name (for xarray) or axis index (for array-like) over which to compute the parameters.

Returns:

• earthkit.meteo.stats.array.GumbelDistribution – Fitting over a dimension of a multi-dimensional sample array, the outcome is a collection of (scalar-valued) distributions.

• admonition:: Implementations – Depending on the type of argument sample, this function calls:

  • earthkit.meteo.stats.xarray.fit_gumbel() for xarray.DataArray

  • earthkit.meteo.stats.array.fit_gumbel() for array_like

  The returned distribution is parameterised from the input sample values.