add warning to square grid generator when boundary does not fully enclose the AOI

Author: joshuacortez

geowrangler/_modidx.py

@@ -199,6 +199,8 @@
                                                                                   'geowrangler/grids.py'),
                                    'geowrangler.grids.get_parallel_intersects': ( 'grids.html#get_parallel_intersects',
                                                                                   'geowrangler/grids.py'),
+                                   'geowrangler.grids.is_aoi_within_boundary': ( 'grids.html#is_aoi_within_boundary',
+                                                                                 'geowrangler/grids.py'),
                                    'geowrangler.grids.setup_boundary': ('grids.html#setup_boundary', 'geowrangler/grids.py')},
             'geowrangler.raster_process': { 'geowrangler.raster_process.query_window_by_gdf': ( 'raster_process.html#query_window_by_gdf',
                                                                                                 'geowrangler/raster_process.py'),

geowrangler/grids.py

@@ -14,6 +14,7 @@
 import numpy as np
 import pandas as pd
 import polars as pl
+import warnings
 from fastcore.all import defaults, parallel
 from fastcore.basics import patch
 from geopandas import GeoDataFrame, GeoSeries
@@ -170,8 +171,26 @@ def setup_boundary(
             x_min, y_min, x_max, y_max, boundary_type="custom_boundary"
         )
 
+    if not is_aoi_within_boundary(boundary, reprojected_gdf):
+        warnings.warn(
+            "The given boundary does not fully enclose the reprojected AOI. There might be missing grid cells due to this. Try getting the boundary of the reprojected AOI, and/or adding a buffer to the boundary. See geowrangler.thinkingmachin.es/tutorial.grids.html#reprojecting-before-gridding for more info."
+        )
+
     return boundary
 
+
+def is_aoi_within_boundary(
+    boundary: Optional[Union[SquareGridGenerator, Iterable[float]]],
+    gdf: GeoDataFrame,
+) -> bool:
+
+    gdf_minx, gdf_miny, gdf_maxx, gdf_maxy = gdf.total_bounds
+    is_x_within_bounds = (gdf_minx >= boundary.x_min) & (gdf_maxx <= boundary.x_max)
+    is_y_within_bounds = (gdf_miny >= boundary.y_min) & (gdf_maxy <= boundary.y_max)
+
+    is_within_bounds = is_x_within_bounds & is_y_within_bounds
+    return is_within_bounds
+
 # %% ../notebooks/00_grids.ipynb 14
 class FastSquareGridGenerator:
     PIXEL_DTYPE = polygon_fill.PIXEL_DTYPE

notebooks/00_grids.ipynb

@@ -69,6 +69,7 @@
     "import numpy as np\n",
     "import pandas as pd\n",
     "import polars as pl\n",
+    "import warnings\n",
     "from fastcore.all import defaults, parallel\n",
     "from fastcore.basics import patch\n",
     "from geopandas import GeoDataFrame, GeoSeries\n",
@@ -278,8 +279,23 @@
     "        x_min, y_min = transformer.transform(boundary[0], boundary[1])\n",
     "        x_max, y_max = transformer.transform(boundary[2], boundary[3])\n",
     "        boundary = SquareGridBoundary(x_min, y_min, x_max, y_max, boundary_type=\"custom_boundary\")\n",
-    " \n",
-    "    return boundary"
+    "\n",
+    "    if not is_aoi_within_boundary(boundary, reprojected_gdf):\n",
+    "        warnings.warn(\"The given boundary does not fully enclose the reprojected AOI. There might be missing grid cells due to this. Try getting the boundary of the reprojected AOI, and/or adding a buffer to the boundary. See geowrangler.thinkingmachin.es/tutorial.grids.html#reprojecting-before-gridding for more info.\")\n",
+    "\n",
+    "    return boundary\n",
+    "\n",
+    "def is_aoi_within_boundary(\n",
+    "    boundary: Optional[Union[SquareGridGenerator,Iterable[float]]],\n",
+    "    gdf: GeoDataFrame,\n",
+    ") -> bool:\n",
+    "\n",
+    "    gdf_minx, gdf_miny, gdf_maxx, gdf_maxy = gdf.total_bounds\n",
+    "    is_x_within_bounds = (gdf_minx >= boundary.x_min) & (gdf_maxx <= boundary.x_max)\n",
+    "    is_y_within_bounds = (gdf_miny >= boundary.y_min) & (gdf_maxy <= boundary.y_max)\n",
+    "\n",
+    "    is_within_bounds = is_x_within_bounds & is_y_within_bounds\n",
+    "    return is_within_bounds"
    ]
   },
   {

notebooks/tutorial.grids.ipynb

@@ -78,13 +78,15 @@ def test_boundary_smaller_then_a_cell():
 
 def test_generate_grids_aoi_outside_boundary(sample_gdf):
     grid_generator = grids.SquareGridGenerator(15000, boundary=(10, 10, 20, 20))
-    grids_gdf = grid_generator.generate_grid(sample_gdf)
+    with pytest.warns(UserWarning):
+        grids_gdf = grid_generator.generate_grid(sample_gdf)
 
     assert len(grids_gdf) == 0
 
 def test_generate_grids_aoi_partially_inside_boundary(sample_gdf):
     grid_generator = grids.SquareGridGenerator(15000, boundary=(0.5, 0.5, 20, 20))
-    grids_gdf = grid_generator.generate_grid(sample_gdf)
+    with pytest.warns(UserWarning):
+        grids_gdf = grid_generator.generate_grid(sample_gdf)
 
     assert len(grids_gdf) == 108
     assert grids_gdf.to_crs("EPSG:3857").area.apply(np.isclose, b=15000**2).all()
@@ -119,13 +121,15 @@ def test_generate_fast_grids_w_custom_boundary_2(sample_gdf):
 
 def test_generate_fast_grids_aoi_outside_boundary(sample_gdf):
     grid_generator = grids.FastSquareGridGenerator(15000, boundary=(10, 10, 20, 20))
-    grids_gdf = grid_generator.generate_grid(sample_gdf)
+    with pytest.warns(UserWarning):
+        grids_gdf = grid_generator.generate_grid(sample_gdf)
 
     assert len(grids_gdf) == 0
 
 def test_generate_fast_grids_aoi_partially_inside_boundary(sample_gdf):
     grid_generator = grids.FastSquareGridGenerator(15000, boundary=(0.5, 0.5, 20, 20))
-    grids_gdf = grid_generator.generate_grid(sample_gdf)
+    with pytest.warns(UserWarning):
+        grids_gdf = grid_generator.generate_grid(sample_gdf)
 
     assert len(grids_gdf) == 108
     assert grids_gdf.to_crs("EPSG:3857").area.apply(np.isclose, b=15000**2).all()