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.DataArrayorarray-like) – Sorted per-point climatology. The reduction dimension (quantiles) is set byclim_dim.ens (
xarray.DataArrayorarray-like) – Ensemble forecast. The reduction dimension (ensemble members) is set byens_dim.eps (
(float)) – Epsilon factor for zero valuesclim_dim (
strorint, optional) – Name (or dimension index for array-like) of the climatology/quantile dimension inclim.ens_dim (
strorint, optional) – Name (or dimension index for array-like) of the ensemble/member dimension inens.
- Returns:
EFI values.
- Return type:
xarray.DataArrayorarray-like
Implementations¶
efi()calls one of the following implementations depending on the type of the input arguments:earthkit.meteo.extreme.array.efi()for array-likeearthkit.meteo.extreme.xarray.efi()for xarray.DataArray
The function returns an object of the same type as the input arguments.