rcatool.stats.pdf.prob_of_exceed

rcatool.stats.pdf.prob_of_exceed(data, keepdims=False, axis=0, thr=None, pctls_levels=None)[source]

Calculates probability of exceedance distriutions.

Parameters:

  • data (array) – 2D or 1D array of data. All data points are collectively used in the freq-instensity calculation unless ‘keepdims’ is True. Then calculation is performed along zeroth axis.

  • pctls_levels ('default', None or array/list) – If set to ‘default’, probability levels of exceedance are defined by a set of percentiles ranging from 0-100 and calculated from input data. If an array or list, these levels (between 0 and 100) will be used instead. Default is None in which case input data is merely ranked from 0 to 1.

  • 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 freq-int dists. If set to False (default) all values are collectively assembled before calculation.

  • axis (int) – The axis over which to apply the calculation if keepdims is set to True. Default is 0.

  • thr (float) – Value of threshold if thresholding data. Default None.

Returns:

eop – exceedance of probability array.

Return type:

array