earthkit.meteo.extreme.efi

earthkit.meteo.extreme.efi(clim: ArrayLike, ens: ArrayLike, eps: float = -0.1, clim_dim: int | None = None, ens_dim: int | None = None) → ArrayLike
earthkit.meteo.extreme.efi(clim: xarray.DataArray, ens: xarray.DataArray, eps: float = -0.1, clim_dim: str | None = None, ens_dim: str | None = None) → xarray.DataArray

Compute Extreme Forecast Index (EFI).

Parameters:

  • clim (xarray.DataArray or array-like) – Sorted per-point climatology. The reduction dimension (quantiles) is set by clim_dim.

  • ens (xarray.DataArray or array-like) – Ensemble forecast. The reduction dimension (ensemble members) is set by ens_dim.

  • eps ((float)) – Epsilon factor for zero values

  • clim_dim (str or int, optional) – Name (or dimension index for array-like) of the climatology/quantile dimension in clim.

  • ens_dim (str or int, optional) – Name (or dimension index for array-like) of the ensemble/member dimension in ens.

Returns:

  • xarray.DataArray or array-like – EFI values.

  • Implementations

  • ------------------------

  • efi() calls one of the following implementations depending on the type of the input arguments

  • - :py:meth:`earthkit.meteo.extreme.array.efi for array-like`

  • - :py:meth:`earthkit.meteo.extreme.xarray.efi for xarray.DataArray`

  • The function returns an object of the same type as the input arguments.