rcatool.stats.climateindex.Rxx

rcatool.stats.climateindex.Rxx(data, thr=1.0, axis=0, normalize=False, keepdims=False)[source]

Rxx mm, count of any time units (days, hours, etc) when precipitation ≥ xx mm: Let RRij be the precipitation amount on time unit i in period j. Count the number of days where RRij ≥ xx mm.

Parameters:
  • data (array) – 1D/2D data array, with time steps on the zeroth axis (axis=0).

  • thr (float/int) – Threshold to be used; eg 10 for R10, 20 R20 etc. Default 1.0.

  • axis (int) – Along which axis to calculate Rxx. Defaults to 0

  • normalize (boolean) – If True (default False) the counts are normalized by total number of time units in each array/grid point. Returned values will then be fractions.

  • keepdims (boolean) – If False (default) calculation is performed on all data collectively, otherwise for each timeseries on each point in 2d space. ‘Axis’ then defines along which axis the timeseries are located.

Returns:

Rxx – 1D/2D array with calculated Rxx indices.

Return type:

list/array