added get_bounds functions for EPSG 4326

climada/util/coordinates.py

@@ -726,7 +726,7 @@
     return str(resolution) + "m"
 
 
 def get_country_geometries(
     country_names=None, extent=None, resolution=10, center_crs=True
 ):
     """Natural Earth country boundaries within given extent
@@ -783,12 +783,22 @@
     if country_names:
         if isinstance(country_names, str):
             country_names = [country_names]
+
+        # print warning if ISO code not recognized
+        for country_name in country_names:
+            if not country_name in nat_earth[["ISO_A3", "WB_A3", "ADM0_A3"]].values:
+                LOGGER.warning(f"ISO code {country_name} not recognized.")
+
         country_mask = np.isin(
             nat_earth[["ISO_A3", "WB_A3", "ADM0_A3"]].values,
             country_names,
         ).any(axis=1)
         out = out[country_mask]
 
+    # exit with Value error if no country code was recognized
+    if out.size == 0:
+        raise ValueError(f"None of the given country codes were recognized.")
+
     if extent:
         if extent[1] - extent[0] > 360:
             raise ValueError(
@@ -1687,6 +1697,84 @@
     return admin1_info, admin1_shapes
 
 
+def global_bounding_box():
+    """
+    Return global bounds in EPSG 4326
+
+    Returns
+    -------
+    tuple:
+        The global bounding box as (min_lon, min_lat, max_lon, max_lat)
+    """
+    return (-180, -90, 180, 90)
+
+
+def get_country_bounding_box(country_names, buffer=1.0):
+    """
+    Return bounding box in EPSG 4326 containing given countries.
+
+    Parameters
+    ----------
+    country_names : list or str
+        list with ISO 3166 alpha-3 codes of countries, e.g ['ZWE', 'GBR', 'VNM', 'UZB']
+    buffer : float, optional
+        Buffer to add to both sides of the bounding box. Default: 1.0.
+
+    Returns
+    -------
+    tuple
+        The bounding box containing all given coutries as (min_lon, min_lat, max_lon, max_lat)
+    """
+
+    country_geometry = get_country_geometries(country_names).geometry
+    longitudes, latitudes = [], []
+    for multipolygon in country_geometry:
+        for polygon in multipolygon.geoms:  # Loop through each polygon
+            for coord in polygon.exterior.coords:  # Extract exterior coordinates
+                longitudes.append(coord[0])
+                latitudes.append(coord[1])
+
+    return latlon_bounds(np.array(latitudes), np.array(longitudes), buffer=buffer)
+
+
+def bounds_from_cardinal_bounds(*, northern, eastern, western, southern):
+    """
+    Return and normalize bounding box in EPSG 4326 from given cardinal bounds.
+
+    Parameters
+    ----------
+    northern : (int, float)
+        Northern boundary of bounding box
+    eastern : (int, float)
+        Eastern boundary of bounding box
+    western : (int, float)
+        Western boundary of bounding box
+    southern : (int, float)
+        Southern boundary of bounding box
+
+    Returns
+    -------
+    tuple
+        The resulting normalized bounding box (min_lon, min_lat, max_lon, max_lat) with -180 <= min_lon < max_lon < 540
+
+    """
+
+    # latitude bounds check
+    if not ((90 >= northern > southern >= -90)):
+        raise ValueError(
+            "Given northern bound is below given southern bound or out of bounds"
+        )
+
+    eastern = (eastern + 180) % 360 - 180
+    western = (western + 180) % 360 - 180
+
+    # Ensure eastern > western
+    if western > eastern:
+        eastern += 360
+
+    return (western, southern, eastern, northern)
+
+
 def get_admin1_geometries(countries):
     """
     return geometries, names and codes of admin 1 regions in given countries

climada/util/test/test_coordinates.py

@@ -2294,6 +2294,69 @@ def test_mask_raster_with_geometry(self):
         )
 
 
+class TestBoundsFromUserInput(unittest.TestCase):
+    """Unit tests for the bounds_from_user_input function."""
+
+    def global_bounding_box(self):
+        """Test for 'global' area selection."""
+        result = u_coord.global_bounding_box()
+        expected = (-180, -90, 180, 90)
+        np.testing.assert_almost_equal(result, expected)
+
+    def test_get_country_bounding_box(self):
+        """Test for a list of ISO country codes."""
+        result = u_coord.get_country_bounding_box(
+            ["ITA"], buffer=1.0
+        )  # Testing with Italy (ITA)
+        # Real expected bounds for Italy (calculated or manually known)
+        expected = [
+            5.6027283120000675,
+            34.48924388200004,
+            19.517425977000073,
+            48.08521494500006,
+        ]  # Italy's bounding box
+
+        np.testing.assert_array_almost_equal(result, expected, decimal=4)
+
+    def test_bounds_from_cardinal_bounds(self):
+        """Test for conversion from cardinal bounds to bounds."""
+        np.testing.assert_array_almost_equal(
+            u_coord.bounds_from_cardinal_bounds(
+                northern=90, southern=-20, eastern=30, western=20
+            ),
+            (20, -20, 30, 90),
+        )
+        np.testing.assert_array_almost_equal(
+            u_coord.bounds_from_cardinal_bounds(
+                northern=90, southern=-20, eastern=20, western=30
+            ),
+            (30, -20, 380, 90),
+        )
+        np.testing.assert_array_almost_equal(
+            u_coord.bounds_from_cardinal_bounds(
+                northern=90, southern=-20, eastern=170, western=-170
+            ),
+            (-170, -20, 170, 90),
+        )
+        np.testing.assert_array_almost_equal(
+            u_coord.bounds_from_cardinal_bounds(
+                northern=90, southern=-20, eastern=-170, western=170
+            ),
+            (170, -20, 190, 90),
+        )
+        np.testing.assert_array_almost_equal(
+            u_coord.bounds_from_cardinal_bounds(
+                northern=90, southern=-20, eastern=170, western=175
+            ),
+            (175, -20, 530, 90),
+        )
+
+    def test_invalid_input_string(self):
+        """Test for invalid string input."""
+        with self.assertRaises(Exception):
+            u_coord.get_bound("invalid_ISO")
+
+
 # Execute Tests
 if __name__ == "__main__":
     TESTS = unittest.TestLoader().loadTestsFromTestCase(TestFunc)
@@ -2302,4 +2365,5 @@ def test_mask_raster_with_geometry(self):
     TESTS.addTests(unittest.TestLoader().loadTestsFromTestCase(TestRasterMeta))
     TESTS.addTests(unittest.TestLoader().loadTestsFromTestCase(TestRasterIO))
     TESTS.addTests(unittest.TestLoader().loadTestsFromTestCase(TestDistance))
+    TESTS.addTests(unittest.TestLoader().loadTestsFromTestCase(TestBoundsFromUserInput))
     unittest.TextTestRunner(verbosity=2).run(TESTS)