Add more docs details

OCHA-DAP · Oct 9, 2024 · 181bdd5 · 181bdd5
1 parent 6954d53
commit 181bdd5
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/src/utils/raster_utils.py b/src/utils/raster_utils.py
@@ -336,7 +336,9 @@ def rasterize_admin(
     Returns
     -------
     numpy.ndarray
-        A 2D array representing the rasterized administrative regions.
+        A 2D array representing the rasterized administrative regions. Each admin region is given an id
+        that matches the index location in the input gdf. If `all_touched=True`, then some admin regions
+        may not be present in the output raster (if they do not have overlap with any pixel centroids)
     """
     gdf["geometry"] = gdf["geometry"].simplify(tolerance=0.001, preserve_topology=True)
     geometries = [