Merge pull request #1066 from CLIMADA-project/hotfix/assign_centroids_in_costbenefit

Hotfix: assign centroids in cost benefit impact calculation if in new exposure no centroids were assigned

Author: ValentinGebhart

climada/engine/cost_benefit.py

@@ -1079,9 +1079,7 @@ def _calc_impact_measures(
         # compute impact for each measure
         for measure in meas_set.get_measure(hazard.haz_type):
             LOGGER.debug("%s impact of measure %s.", when, measure.name)
-            imp_tmp, risk_transf = measure.calc_impact(
-                exposures, imp_fun_set, hazard, assign_centroids=False
-            )
+            imp_tmp, risk_transf = measure.calc_impact(exposures, imp_fun_set, hazard)
             impact_meas[measure.name] = dict()
             impact_meas[measure.name]["cost"] = (
                 measure.cost,

climada/engine/test/test_cost_benefit.py

@@ -35,6 +35,8 @@
 )
 from climada.entity.disc_rates import DiscRates
 from climada.entity.entity_def import Entity
+from climada.entity.measures import Measure
+from climada.entity.measures.base import LOGGER as ILOG
 from climada.hazard.base import Hazard
 from climada.test import get_test_file
 from climada.util.api_client import Client
@@ -1119,6 +1121,66 @@ def test_remove_measure(self):
         self.assertEqual(len(cost_ben.cost_ben_ratio), 3)
         self.assertEqual(len(cost_ben.benefit), 3)
 
+    def test_measure_exposure_no_centroids(self):
+        """Test centroids assigned if no centroids were assigned in Measure Exposures object"""
+        hazard = Hazard.from_hdf5(HAZ_TEST_TC)
+        entity = Entity.from_excel(ENT_DEMO_TODAY)
+        entity.check()
+        entity.exposures.ref_year = 2018
+
+        # test that warning is not raised when centroid are assigned
+        try:
+            with self.assertLogs(ILOG, level="WARNING") as logs:
+                cost_ben = CostBenefit()
+                cost_ben.calc(
+                    hazard,
+                    entity,
+                    future_year=2040,
+                    risk_func=risk_aai_agg,
+                    imp_time_depen=None,
+                    save_imp=True,
+                )
+                for log in logs.output:
+                    self.assertNotIn(
+                        "No assigned hazard centroids in exposure object after",
+                        log,
+                        "Centroids are already assinged in Measure Exposure object"
+                        "and should not be reassigned.",
+                    )
+        except AssertionError as e:
+            if "no logs" in str(e).lower():
+                pass
+            else:
+                raise
+
+        # add measure with exposure without assigned centroids
+        exp_no_assigned_centroids = entity.exposures.copy()
+        exp_no_assigned_centroids.data = entity.exposures.data.drop(
+            columns=["centr_TC"]
+        )
+        entity.measures.append(
+            Measure(
+                name="no centroids",
+                haz_type="TC",
+                exposures_set=exp_no_assigned_centroids,
+            )
+        )
+
+        # test if warning is raised
+        with self.assertLogs(ILOG, level="WARNING") as logs:
+            cost_ben = CostBenefit()
+            cost_ben.calc(
+                hazard,
+                entity,
+                future_year=2040,
+                risk_func=risk_aai_agg,
+                imp_time_depen=None,
+                save_imp=True,
+            )
+        self.assertIn(
+            "No assigned hazard centroids in exposure object after", logs.output[0]
+        )
+
 
 class TestCalc(unittest.TestCase):
     """Test calc"""

climada/entity/measures/base.py

@@ -179,7 +179,7 @@ def check(self):
         u_check.size(2, self.mdd_impact, "Measure.mdd_impact")
         u_check.size(2, self.paa_impact, "Measure.paa_impact")
 
-    def calc_impact(self, exposures, imp_fun_set, hazard, assign_centroids=True):
+    def calc_impact(self, exposures, imp_fun_set, hazard):
         """
         Apply measure and compute impact and risk transfer of measure
         implemented over inputs.
@@ -192,12 +192,6 @@ def calc_impact(self, exposures, imp_fun_set, hazard, assign_centroids=True):
             impact function set instance
         hazard : climada.hazard.Hazard
             hazard instance
-        assign_centroids : bool, optional
-            indicates whether centroids are assigned to the self.exposures object.
-            Centroids assignment is an expensive operation; set this to ``False`` to save
-            computation time if the hazards' centroids are already assigned to the exposures
-            object.
-            Default: True
 
         Returns
         -------
@@ -206,7 +200,17 @@ def calc_impact(self, exposures, imp_fun_set, hazard, assign_centroids=True):
         """
 
         new_exp, new_impfs, new_haz = self.apply(exposures, imp_fun_set, hazard)
-        return self._calc_impact(new_exp, new_impfs, new_haz, assign_centroids)
+        # assign centroids if missing
+        if new_haz.centr_exp_col not in new_exp.gdf.columns:
+            LOGGER.warning(
+                "No assigned hazard centroids in exposure object after the "
+                "application of the measure. The centroids will be assigned during impact "
+                "calculation. This is potentiall costly. To silence this warning, make sure "
+                "that centroids are assigned to all exposures."
+            )
+            new_exp.assign_centroids(new_haz)
+
+        return self._calc_impact(new_exp, new_impfs, new_haz)
 
     def apply(self, exposures, imp_fun_set, hazard):
         """
@@ -246,7 +250,7 @@ def apply(self, exposures, imp_fun_set, hazard):
 
         return new_exp, new_impfs, new_haz
 
-    def _calc_impact(self, new_exp, new_impfs, new_haz, assign_centroids):
+    def _calc_impact(self, new_exp, new_impfs, new_haz):
         """Compute impact and risk transfer of measure implemented over inputs.
 
         Parameters
@@ -267,7 +271,7 @@ def _calc_impact(self, new_exp, new_impfs, new_haz, assign_centroids):
         )
 
         imp = ImpactCalc(new_exp, new_impfs, new_haz).impact(
-            save_mat=False, assign_centroids=assign_centroids
+            save_mat=False, assign_centroids=False
         )
         return imp.calc_risk_transfer(self.risk_transf_attach, self.risk_transf_cover)