Merge branch 'implement_mean_min_max' into implement_quantiles

Author: luseverin

climada/engine/impact_forecast.py

@@ -242,29 +242,29 @@ def select(
             reset_frequency=reset_frequency,
         )
 
-    def _reduce_attrs(self, reduce_method: str):
+    def _reduce_attrs(self, event_name: str):
         """
         Reduce the attributes of an ImpactForecast to a single value.
 
         Attributes are modified as follows:
         - lead_time: set to NaT
         - member: set to -1
         - event_id: set to 0
-        - event_name: set to reduce_method
-        - date: set to the minimum value
+        - event_name: set to the name of the reduction method (default)
+        - date: set to 0
         - frequency: set to 1
 
         Parameters
         ----------
-        reduce_method : str
-            The reduction method used to reduce the attributes.
+        event_name : str
+            The event name given to the reduced data.
         """
         reduced_attrs = {
             "lead_time": np.array([np.timedelta64("NaT")]),
             "member": np.array([-1]),
             "event_id": np.array([0]),
-            "event_name": np.array([reduce_method]),
-            "date": np.array([self.date.min()]),
+            "event_name": np.array([event_name]),
+            "date": np.array([0]),
             "frequency": np.array([1]),
         }
 
@@ -346,9 +346,6 @@ def mean(self):
         """
         Reduce the impact matrix and at_event of an ImpactForecast to the mean value.
 
-        The mean value is computed by taking the mean of the impact matrix along the
-        exposure points axis (axis=1) and then taking the mean of the resulting array.
-
         Parameters
         ----------
         None

climada/engine/test/test_impact_forecast.py

@@ -258,6 +258,6 @@ def test_impact_forecast_mean_min_max(impact_forecast):
     assert imp_fcst_mean.frequency == 1
     assert imp_fcst_min.frequency == 1
     assert imp_fcst_max.frequency == 1
-    assert imp_fcst_mean.date == impact_forecast.date.min()
-    assert imp_fcst_min.date == impact_forecast.date.min()
-    assert imp_fcst_max.date == impact_forecast.date.min()
+    assert imp_fcst_mean.date == 0
+    assert imp_fcst_min.date == 0
+    assert imp_fcst_max.date == 0

climada/hazard/forecast.py

@@ -106,29 +106,29 @@ def _check_sizes(self):
         size(exp_len=num_entries, var=self.member, var_name="Forecast.member")
         size(exp_len=num_entries, var=self.lead_time, var_name="Forecast.lead_time")
 
-    def _reduce_attrs(self, reduce_method: str):
+    def _reduce_attrs(self, event_name: str):
         """
         Reduce the attributes of a HazardForecast to a single value.
 
         Attributes are modified as follows:
         - lead_time: set to NaT
         - member: set to -1
         - event_id: set to 0
-        - event_name: set to reduce_method
-        - date: set to the minimum value
+        - event_name: set to the name of the reduction method (default)
+        - date: set to 0
         - frequency: set to 1
 
         Parameters
         ----------
-        reduce_method : str
-            The reduction method used to reduce the attributes.
+        event_name : str
+            The event_name given to the reduced data.
         """
         reduced_attrs = {
             "lead_time": np.array([np.timedelta64("NaT")]),
             "member": np.array([-1]),
             "event_id": np.array([0]),
-            "event_name": np.array([reduce_method]),
-            "date": np.array([self.date.min()]),
+            "event_name": np.array([event_name]),
+            "date": np.array([0]),
             "frequency": np.array([1]),
             "orig": np.array([True]),
         }
@@ -137,7 +137,7 @@ def _reduce_attrs(self, reduce_method: str):
 
     def min(self):
         """
-        Reduce the impact matrix and at_event of a HazardForecast to the minimum
+        Reduce the intensity and fraction of a HazardForecast to the minimum
         value.
 
         Parameters
@@ -171,7 +171,7 @@ def min(self):
 
     def max(self):
         """
-        Reduce the impact matrix and at_event of a HazardForecast to the maximum
+        Reduce the intensity and fraction of a HazardForecast to the maximum
         value.
 
         Parameters
@@ -205,10 +205,7 @@ def max(self):
 
     def mean(self):
         """
-        Reduce the impact matrix and at_event of a HazardForecast to the mean value.
-
-        The mean value is computed by taking the mean of the impact matrix along the
-        exposure points axis (axis=1) and then taking the mean of the resulting array.
+        Reduce the intensity and fraction of a HazardForecast to the mean value.
 
         Parameters
         ----------

climada/hazard/test/test_forecast.py

@@ -209,9 +209,9 @@ def test_hazard_forecast_mean_min_max(haz_fc):
     assert haz_fcst_mean.frequency == 1
     assert haz_fcst_min.frequency == 1
     assert haz_fcst_max.frequency == 1
-    assert haz_fcst_mean.date == haz_fc.date.min()
-    assert haz_fcst_min.date == haz_fc.date.min()
-    assert haz_fcst_max.date == haz_fc.date.min()
+    assert haz_fcst_mean.date == 0
+    assert haz_fcst_min.date == 0
+    assert haz_fcst_max.date == 0
     assert np.all(haz_fcst_mean.orig)
     assert np.all(haz_fcst_min.orig)
     assert np.all(haz_fcst_max.orig)