earthkit.meteo.regimes.regime_index¶
- earthkit.meteo.regimes.regime_index(projections, mean, std)¶
Regime index by standardisation of projections onto patterns.
- Parameters:
projections (
xarray.DataArray | array_like) – Projections onto regime patterns.mean (
xarray.DataArray | array_like)std (
xarray.DataArray | array_like)
- Returns:
Standardised projection.
- Return type:
xarray.DataArray | array_like
Implementations
Depending on the type of argument projections, this function calls:
earthkit.meteo.regimes.array.regime_index()forarray_likeearthkit.meteo.regimes.xarray.regime_index()forxarray.DataArray
The function returns an object of the same type as the input argument.
Notes
The standardised projection is calculated as:
(projection - mean) / std