i.biomass: added test file for i.biomass module (#4962)

imagery/i.biomass/testsuite/test_i_biomass.py

@@ -0,0 +1,298 @@
+import numpy as np
+from grass.script import array
+from grass.gunittest.case import TestCase
+from grass.gunittest.main import test
+
+
+class TestIBiomass(TestCase):
+    """Regression tests for the i.biomass GRASS GIS module."""
+
+    input_rasters = {
+        "fpar": "test_fpar",
+        "lightuse_eff": "test_lightuse_eff",
+        "latitude": "test_latitude",
+        "dayofyear": "test_dayofyear",
+        "transmissivity": "test_transmissivity",
+        "water": "test_water_availability",
+    }
+    output_raster = "biomass_output"
+
+    @classmethod
+    def setUpClass(cls):
+        """Set up input rasters and configure test environment."""
+        cls.use_temp_region()
+        cls.runModule("g.region", n=10, s=0, e=10, w=0, rows=10, cols=10)
+
+        input_expressions = {
+            "fpar": "col() * 0.1",
+            "lightuse_eff": "row() * 0.1",
+            "latitude": "45.0",
+            "dayofyear": "150",
+            "transmissivity": "0.75",
+            "water": "0.8",
+        }
+        cls._create_input_rasters(input_expressions)
+
+    @classmethod
+    def _create_input_rasters(cls, expressions):
+        """Helper method to create input rasters with specified expressions."""
+        for raster_key, expr in expressions.items():
+            raster_name = cls.input_rasters[raster_key]
+            cls.runModule(
+                "r.mapcalc", expression=f"{raster_name} = {expr}", overwrite=True
+            )
+
+    @classmethod
+    def tearDownClass(cls):
+        """Clean up generated data and reset the region."""
+        rasters_to_remove = list(cls.input_rasters.values()) + [cls.output_raster]
+        cls.runModule(
+            "g.remove",
+            type="raster",
+            name=",".join(rasters_to_remove),
+            flags="f",
+            quiet=True,
+        )
+        cls.del_temp_region()
+
+    def test_biomass_against_reference(self):
+        """
+        Compare output of i.biomass with precomputed reference statistics.
+        The reference raster was created using the following commands:
+        g.region n=10 s=0 e=10 w=0 rows=10 cols=10
+        r.mapcalc "test_fpar = col() * 0.1"
+        r.mapcalc "test_lightuse_eff = row() * 0.1"
+        r.mapcalc "test_latitude = 45.0"
+        r.mapcalc "test_dayofyear = 150"
+        r.mapcalc "test_transmissivity = 0.75"
+        r.mapcalc "test_water_availability = 0.8"
+        i.biomass fpar=test_fpar lightuse_efficiency=test_lightuse_eff \
+        latitude=test_latitude dayofyear=test_dayofyear \
+        transmissivity_singleway=test_transmissivity \
+        water_availability=test_water_availability output=biomass_reference
+        r.univar -g biomass_reference
+        """
+        input_expressions = {
+            "fpar": "col() * 0.1",
+            "lightuse_eff": "row() * 0.1",
+            "latitude": "45.0",
+            "dayofyear": "150",
+            "transmissivity": "0.75",
+            "water": "0.8",
+        }
+        self._create_input_rasters(input_expressions)
+
+        self.assertModule(
+            "i.biomass",
+            fpar=self.input_rasters["fpar"],
+            lightuse_efficiency=self.input_rasters["lightuse_eff"],
+            latitude=self.input_rasters["latitude"],
+            dayofyear=self.input_rasters["dayofyear"],
+            transmissivity_singleway=self.input_rasters["transmissivity"],
+            water_availability=self.input_rasters["water"],
+            output=self.output_raster,
+            overwrite=True,
+        )
+        self.assertRasterExists(self.output_raster)
+
+        expected_stats = "min=0.752654\nmax=75.265445\nmean=22.767797\nstddev=17.924991"
+        self.assertRasterFitsUnivar(
+            raster=self.output_raster, reference=expected_stats, precision=1e-6
+        )
+
+    def test_biomass_linearity(self):
+        """Test linearity of i.biomass by scaling inputs."""
+        input_expressions = {
+            "fpar": "col() * 0.5",
+            "lightuse_eff": "row() * 0.1",
+            "latitude": "45.0",
+            "dayofyear": "150",
+            "transmissivity": "0.75",
+            "water": "0.8",
+        }
+        self._create_input_rasters(input_expressions)
+
+        self.assertModule(
+            "i.biomass",
+            fpar=self.input_rasters["fpar"],
+            lightuse_efficiency=self.input_rasters["lightuse_eff"],
+            latitude=self.input_rasters["latitude"],
+            dayofyear=self.input_rasters["dayofyear"],
+            transmissivity_singleway=self.input_rasters["transmissivity"],
+            water_availability=self.input_rasters["water"],
+            output=self.output_raster,
+            overwrite=True,
+        )
+        self.assertRasterExists(self.output_raster)
+
+        scaled_output_values = array.array(self.output_raster)
+
+        self.runModule(
+            "r.mapcalc",
+            expression=f"{self.input_rasters['fpar']} = col() * 1.0",
+            overwrite=True,
+        )
+        self.assertModule(
+            "i.biomass",
+            fpar=self.input_rasters["fpar"],
+            lightuse_efficiency=self.input_rasters["lightuse_eff"],
+            latitude=self.input_rasters["latitude"],
+            dayofyear=self.input_rasters["dayofyear"],
+            transmissivity_singleway=self.input_rasters["transmissivity"],
+            water_availability=self.input_rasters["water"],
+            output=self.output_raster,
+            overwrite=True,
+        )
+        self.assertRasterExists(self.output_raster)
+
+        original_output_values = array.array(self.output_raster)
+        self.assertTrue(
+            np.allclose(scaled_output_values * 2, original_output_values, atol=1e-5),
+            "Linearity property failed for biomass computation",
+        )
+
+    def test_biomass_with_extreme_values(self):
+        """Test the behavior of i.biomass with extreme input values."""
+        extreme_values = {
+            "fpar": [0, 1],
+            "lightuse_eff": [0, 10],
+            "latitude": [-90, 90],
+            "dayofyear": [1, 365],
+            "transmissivity": [0, 1],
+            "water": [0, 1],
+        }
+
+        for key, (min_val, max_val) in extreme_values.items():
+            self.runModule(
+                "r.mapcalc",
+                expression=f"{self.input_rasters[key]} = {min_val}",
+                overwrite=True,
+            )
+
+        self.assertModule(
+            "i.biomass",
+            fpar=self.input_rasters["fpar"],
+            lightuse_efficiency=self.input_rasters["lightuse_eff"],
+            latitude=self.input_rasters["latitude"],
+            dayofyear=self.input_rasters["dayofyear"],
+            transmissivity_singleway=self.input_rasters["transmissivity"],
+            water_availability=self.input_rasters["water"],
+            output=self.output_raster,
+            overwrite=True,
+        )
+        self.assertRasterExists(self.output_raster)
+
+        output_values_min = array.array(self.output_raster)
+        self.assertTrue(
+            np.all(output_values_min >= 0),
+            "Biomass output should not contain negative values.",
+        )
+
+        for key, (min_val, max_val) in extreme_values.items():
+            self.runModule(
+                "r.mapcalc",
+                expression=f"{self.input_rasters[key]} = {max_val}",
+                overwrite=True,
+            )
+
+        self.assertModule(
+            "i.biomass",
+            fpar=self.input_rasters["fpar"],
+            lightuse_efficiency=self.input_rasters["lightuse_eff"],
+            latitude=self.input_rasters["latitude"],
+            dayofyear=self.input_rasters["dayofyear"],
+            transmissivity_singleway=self.input_rasters["transmissivity"],
+            water_availability=self.input_rasters["water"],
+            output=self.output_raster,
+            overwrite=True,
+        )
+        self.assertRasterExists(self.output_raster)
+
+        output_values_max = array.array(self.output_raster)
+        self.assertTrue(
+            np.all(np.isfinite(output_values_max)),
+            "Biomass output contains non-finite values.",
+        )
+
+    def test_biomass_latitude_dependency(self):
+        """Test that biomass values vary reasonably with latitude."""
+        input_expressions = {
+            "fpar": "col() * 0.1",
+            "lightuse_eff": "row() * 0.1",
+            "latitude": "0",
+            "dayofyear": "150",
+            "transmissivity": "0.75",
+            "water": "0.8",
+        }
+        self._create_input_rasters(input_expressions)
+
+        self.assertModule(
+            "i.biomass",
+            fpar=self.input_rasters["fpar"],
+            lightuse_efficiency=self.input_rasters["lightuse_eff"],
+            latitude=self.input_rasters["latitude"],
+            dayofyear=self.input_rasters["dayofyear"],
+            transmissivity_singleway=self.input_rasters["transmissivity"],
+            water_availability=self.input_rasters["water"],
+            output=self.output_raster,
+            overwrite=True,
+        )
+        equatorial_output = array.array(self.output_raster)
+
+        self.runModule(
+            "r.mapcalc",
+            expression=f"{self.input_rasters['latitude']} = 90",
+            overwrite=True,
+        )
+        self.assertModule(
+            "i.biomass",
+            fpar=self.input_rasters["fpar"],
+            lightuse_efficiency=self.input_rasters["lightuse_eff"],
+            latitude=self.input_rasters["latitude"],
+            dayofyear=self.input_rasters["dayofyear"],
+            transmissivity_singleway=self.input_rasters["transmissivity"],
+            water_availability=self.input_rasters["water"],
+            output=self.output_raster,
+            overwrite=True,
+        )
+        polar_output = array.array(self.output_raster)
+
+        self.assertTrue(
+            np.mean(equatorial_output) > np.mean(polar_output),
+            "Biomass at equatorial regions should generally exceed biomass at polar regions.",
+        )
+
+    def test_biomass_ecological_range(self):
+        """Test that biomass values fall within an expected ecological range."""
+        input_expressions = {
+            "fpar": "col() * 0.5",
+            "lightuse_eff": "row() * 0.1",
+            "latitude": "45.0",
+            "dayofyear": "150",
+            "transmissivity": "0.75",
+            "water": "0.8",
+        }
+        self._create_input_rasters(input_expressions)
+
+        self.assertModule(
+            "i.biomass",
+            fpar=self.input_rasters["fpar"],
+            lightuse_efficiency=self.input_rasters["lightuse_eff"],
+            latitude=self.input_rasters["latitude"],
+            dayofyear=self.input_rasters["dayofyear"],
+            transmissivity_singleway=self.input_rasters["transmissivity"],
+            water_availability=self.input_rasters["water"],
+            output=self.output_raster,
+            overwrite=True,
+        )
+        self.assertRasterExists(self.output_raster)
+
+        output_values = array.array(self.output_raster)
+        self.assertTrue(
+            np.all((output_values >= 0) & (output_values <= 1000)),
+            "Biomass output values should be within the range [0, 1000].",
+        )
+
+
+if __name__ == "__main__":
+    test()