adapted docstring for extrapoaltion

CLIMADA-project · Feb 14, 2025 · 30bd733 · 30bd733
1 parent 0457286
commit 30bd733
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 3 deletions.
diff --git a/climada/engine/impact.py b/climada/engine/impact.py
@@ -516,7 +516,10 @@ def local_exceedance_impact(
             return periods larger than the Impact object's observed local return periods will be
             assigned the largest local impact, and return periods smaller than the Impact object's
             observed local return periods will be assigned 0. If set to "extrapolate", local
-            exceedance impacts will be extrapolated (and interpolated). Defauls to "interpolate".
+            exceedance impacts will be extrapolated (and interpolated). The extrapolation to
+            large return periods uses the two highest impacts of the centroid and their return
+            periods and extends the interpolation between these points to the given return period
+            (similar for small return periods). Defauls to "interpolate".
         min_impact : float, optional
             Minimum threshold to filter the impact. Defaults to 0.
         log_frequency : bool, optional
@@ -648,6 +651,9 @@ def local_return_period(
             impacts will be assigned NaN, and threshold impacts smaller than the Impact
             object's local impacts will be assigned the smallest observed local return period.
             If set to "extrapolate", local return periods will be extrapolated (and interpolated).
+            The extrapolation to large threshold impacts uses the two highest impacts of
+            the centroid and their return periods and extends the interpolation between these
+            points to the given threshold imapct (similar for small large threshold impacts).
             Defaults to "interpolate".
         min_impacts : float, optional
             Minimum threshold to filter the impact. Defaults to 0.

diff --git a/climada/hazard/base.py b/climada/hazard/base.py
@@ -509,8 +509,10 @@ def local_exceedance_intensity(
             periods larger than the Hazard object's observed local return periods will be assigned
             the largest local intensity, and return periods smaller than the Hazard object's
             observed local return periods will be assigned 0. If set to "extrapolate", local
-            exceedance intensities will be extrapolated (and interpolated).
-            Defauls to "interpolate".
+            exceedance intensities will be extrapolated (and interpolated). The extrapolation to
+            large return periods uses the two highest intensites of the centroid and their return
+            periods and extends the interpolation between these points to the given return period
+            (similar for small return periods). Defauls to "interpolate".
         min_intensity : float, optional
             Minimum threshold to filter the hazard intensity. If set to None, self.intensity_thres
             will be used. Defaults to None.
@@ -640,6 +642,9 @@ def local_return_period(
             intensities will be assigned NaN, and threshold intensities smaller than the Hazard
             object's local intensities will be assigned the smallest observed local return period.
             If set to "extrapolate", local return periods will be extrapolated (and interpolated).
+            The extrapolation to large threshold intensities uses the two highest intensites of
+            the centroid and their return periods and extends the interpolation between these
+            points to the given threshold intensity (similar for small threshold intensites).
             Defaults to "interpolate".
         min_intensity : float, optional
             Minimum threshold to filter the hazard intensity. If set to None, self.intensity_thres