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) – Projections onto regime patterns.

  • mean (xarray.DataArray)

  • std (xarray.DataArray)

Returns:

Standardised projection.

Return type:

xarray.DataArray

Implementations

Depending on the type of argument projections, this function calls:

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

Notes

The standardised projection is calculated as:

(projection - mean) / std