hydromt.stats.extremes.get_return_value#

hydromt.stats.extremes.get_return_value(da_params: DataArray, rps: ndarray[Any, dtype[int64]] = array([2, 5, 10, 25, 50, 100, 250, 500]), extremes_rate: float = 1.0) → DataArray[source]#

Return return value based on EVA.

Return return values based on a fitted extreme value distribution using the fit_extremes() method based on the scipy inverse survival function (isf).

Parameters:

  • da_params (xr.DataArray) – Short name and parameters of extreme value distribution, see also fit_extremes().

  • rps (np.ndarray, optional) – Array of return periods in years, by default [1.5, 2, 5, 10, 20, 50, 100, 200, 500]

  • extremes_rate (float, optional) – Average number of peaks per period, by default 1.0 Only used if extremes_rate is not provided as coordinate in da_params.

Returns:

Return values

Return type:

xr.DataArray