earthkit.meteo.extreme.sot_unsorted¶
- earthkit.meteo.extreme.sot_unsorted(clim: ArrayLike, ens: ArrayLike, perc: int, eps: float = -10000.0, clim_dim: int | None = None, ens_dim: int | None = None) ArrayLike¶
- earthkit.meteo.extreme.sot_unsorted(clim: xarray.DataArray, ens: xarray.DataArray, perc: int, eps: float = -10000.0, clim_dim: str | None = None, ens_dim: str | None = None) xarray.DataArray
Compute Shift of Tails (SOT) from climatology percentiles (sorted) and ensemble forecast (not sorted).
- Parameters:
clim (
array-likeorxarray.DataArray) – Model climatology (percentiles). The reduction dimension is set byclim_dim.ens (
array-likeorxarray.DataArray) – Ensemble forecast. The reduction dimension is set byens_dim.perc (
int) – Percentile value (typically 10 or 90)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:
SOT values.
- Return type:
array-likeorxarray.DataArray
Implementations¶
sot_unsorted()calls one of the following implementations depending on the type of the input arguments:earthkit.meteo.extreme.array.sot_unsorted()for array-likeearthkit.meteo.extreme.xarray.sot_unsorted()for xarray.DataArray
The function returns an object of the same type as the input arguments.