rcatool.stats.climateindex.ehi

rcatool.stats.climateindex.ehi(data, thr_95, axis=0, keepdims=False)[source]

Calculate Excessive Heat Index (EHI).

Parameters:
  • data (list/array) – 1D/2D array of daily temperature timeseries

  • thr_95 (float) – 95th percentile daily mean value from climatology

  • axis (int) – The axis along which the calculation is applied (default 0).

  • keepdims (boolean) – If data is 2d (time in third dimesion) and keepdims is set to True, calculation is applied to the zeroth axis (time) and returns a 2d array of calculated statistics. If set to False (default) all values are collectively assembled before calculation.

Returns:

EHI – Excessive heat index

Return type:

float