Merge pull request allixender#36 from crim-ca/forward-densification-params

ensure that cell edge densification parameters are forwarded

Author: allixender

dggrid4py/dggrid_runner.py

@@ -299,6 +299,7 @@ def get_geo_out(legacy=True, has_gdal=True):
         "clip_cell_res": int,
         "clip_cell_addresses": str,
         "clip_region_files": str,
+        "clip_cell_densification": int,
         "clipper_scale_factor": float,
         "input_address_type": DggsInputAddressTypeT,
         "input_hier_ndx_form": DggsInputHierNdxFormT,
@@ -555,8 +556,14 @@ class Dggs:
         # Add more aliases as needed
     }, init=False, repr=False)
 
-    def _resolve_key(self, key: str) -> str:
+    def _resolve_key(self, key: str, strict: bool = False) -> str | None:
         # If key is an alias, return canonical; else if it's a canonical, return as is
+        if strict:
+            if key in self._aliases:
+                return self._aliases[key]
+            elif key in self.__dataclass_fields__:
+                return key
+            return None
         return self._aliases.get(key, key)
 
     def set_par(self, par_key: str, par_value: DggridMetaConfigParameterT):
@@ -589,12 +596,16 @@ def to_dict(self) -> dict[str, DggridMetaConfigParameterT]:
     def metafile(self) -> DggridMetafileT:
         return copy.copy(dg_grid_meta(self))
 
-    def update(self, **kwargs):
+    def update(self, strict=False, **kwargs):
         """
         Back propagate keyword parameters if they can be mapped to an attribute handled by this class.
+
+        :param strict:
+            If True, only keys that match existing attributes will be set.
+            If False, unknown keys will be set with provided name.
         """
         for key, value in kwargs.items():
-            found = self._resolve_key(key)
+            found = self._resolve_key(key, strict=strict)
             if found:
                 self.set_par(found, value)
 
@@ -1275,6 +1286,7 @@ def grid_cell_polygons_for_extent(
         tmp_id = uuid.uuid4()
         tmp_dir = self.working_dir
         dggs = dgselect(dggs_type = dggs_type, res= resolution, mixed_aperture_level=mixed_aperture_level)
+        dggs.update(**conf_extra, strict=True)
 
         subset_conf: DggridMetaConfigT = { 'update_frequency': 100000, 'clip_subset_type': 'WHOLE_EARTH' }
 
@@ -1372,6 +1384,7 @@ def grid_cell_centroids_for_extent(
         tmp_id = uuid.uuid4()
         tmp_dir = self.working_dir
         dggs = dgselect(dggs_type = dggs_type, res= resolution, mixed_aperture_level=mixed_aperture_level)
+        dggs.update(**conf_extra, strict=True)
 
         subset_conf: DggridMetaConfigT = { 'update_frequency': 100000, 'clip_subset_type': 'WHOLE_EARTH' }
 
@@ -1470,6 +1483,7 @@ def grid_cell_polygons_from_cellids(
         tmp_id = uuid.uuid4()
         tmp_dir = self.working_dir
         dggs = dgselect(dggs_type = dggs_type, res= resolution, mixed_aperture_level=mixed_aperture_level)
+        dggs.update(**conf_extra, strict=True)
 
         subset_conf: DggridMetaConfigT = { 'update_frequency': 100000, 'clip_subset_type': clip_subset_type }
         seq_df = None
@@ -1506,6 +1520,12 @@ def grid_cell_polygons_from_cellids(
                             'clip_cell_addresses' : " ".join([str(address) for address in cell_id_list])
                         }
                     )
+                    if "clip_cell_densification" in conf_extra:
+                        subset_conf.update(
+                            {
+                                'clip_cell_densification' : conf_extra['clip_cell_densification']
+                            }
+                        )
 
         subset_conf.update(specify_resolution(**conf_extra))
         subset_conf.update(specify_orient_type_args(**conf_extra))
@@ -1610,6 +1630,7 @@ def grid_cell_centroids_from_cellids(
         tmp_id = uuid.uuid4()
         tmp_dir = self.working_dir
         dggs = dgselect(dggs_type = dggs_type, res= resolution, mixed_aperture_level=mixed_aperture_level)
+        dggs.update(**conf_extra, strict=True)
 
         subset_conf: DggridMetaConfigT = { 'update_frequency': 100000, 'clip_subset_type': clip_subset_type }
         seq_df = None
@@ -1737,6 +1758,7 @@ def grid_cellids_for_extent(
         tmp_id = uuid.uuid4()
         tmp_dir = self.working_dir
         dggs = dgselect(dggs_type = dggs_type, res= resolution, mixed_aperture_level=mixed_aperture_level)
+        dggs.update(**conf_extra, strict=True)
 
         subset_conf = { 'update_frequency': 100000, 'clip_subset_type': 'WHOLE_EARTH' }
 
@@ -1821,6 +1843,7 @@ def cells_for_geo_points(
         tmp_id = uuid.uuid4()
         tmp_dir = self.working_dir
         dggs = dgselect(dggs_type = dggs_type, res= resolution, mixed_aperture_level=mixed_aperture_level)
+        dggs.update(**conf_extra, strict=True)
 
         cols = set(geodf_points_wgs84.columns.tolist())
         cols = cols - set('geometry')
@@ -1917,6 +1940,7 @@ def address_transform(
         tmp_id = uuid.uuid4()
         tmp_dir = self.working_dir
         dggs = dgselect(dggs_type = dggs_type, res= resolution, mixed_aperture_level=mixed_aperture_level)
+        dggs.update(**conf_extra, strict=True)
 
         if cell_id_list is None or len(cell_id_list) <= 0:
             raise ValueError("Expecting cell_id_list to transform.")

tests/test_dggrid.py

@@ -5,6 +5,7 @@
 import shapely
 
 from dggrid4py import DGGRIDv8, Dggs
+from dggrid4py.dggrid_runner import output_hier_ndx_forms
 
 dggrid = DGGRIDv8()
 
@@ -149,6 +150,8 @@ def mock_dggrid_grid_gen_run(__metafile):
         dggrid.grid_cell_polygons_for_extent(
             dggs_type="IGEO7",
             resolution=3,
+            densification=5,
+            geodetic_densify=0.01,
             clip_geom=clip_bound,
             # use string to preserve precision and training zeros explicitly
             dggs_vert0_azimuth=0.0,
@@ -173,6 +176,8 @@ def mock_dggrid_grid_gen_run(__metafile):
         # NOTE: 'dggs_res_spec' to be inferred from Dggs() attribute, not passing it explicitly to 'specify_resolution'
         "dggs_res_spec 3",
         "precision 7",
+        "densification 5",
+        "geodetic_densify 0.01",
         "clip_subset_type GDAL",
         # "clip_region_files /tmp/dggrid/...",
         # "cell_output_file_name /tmp/dggrid/...",
@@ -190,3 +195,72 @@ def mock_dggrid_grid_gen_run(__metafile):
         # "output_hier_ndx_form DIGIT_STRING",
         "point_output_type NONE"
     }
+
+
+def test_grid_cell_polygons_from_cellids(monkeypatch):
+    metafile = []
+
+    def mock_dggrid_grid_gen_run(__metafile):
+        metafile[:] = __metafile
+        return -1  # cause grid_gen to early-exit in error
+
+    monkeypatch.setattr(dggrid, "run", mock_dggrid_grid_gen_run)
+
+    with pytest.raises(ValueError):  # catch and ignore (early-abort "run error")
+        dggrid.grid_cell_polygons_from_cellids(
+            dggs_type="IGEO7",
+            resolution=3,
+            cell_id_list=["023"],
+            clip_cell_densification=5,
+            clip_subset_type="COARSE_CELLS",  # required for densification to take effect
+            input_address_type="HIERNDX",
+            input_hier_ndx_forms="DIGIT_STRING",
+            input_hier_ndx_systems="Z7",
+            output_cell_label_type="OUTPUT_ADDRESS_TYPE",
+            output_address_type="HIERNDX",
+            output_hier_ndx_forms="DIGIT_STRING",
+            output_hier_ndx_systems="Z7",
+            # use string to preserve precision and training zeros explicitly
+            dggs_vert0_azimuth=0.0,
+            dggs_vert0_lat="58.282525588538994675786",  # default: 58.28252559
+            dggs_vert0_lon="11.20",   # default: 11.25
+        )
+
+    # pre-check temp file paths to ignore in check of specific values
+    meta_args = dict([line.split(" ") for line in metafile])
+    assert meta_args["clip_region_files"].startswith("/tmp/dggrid")
+    assert meta_args["cell_output_file_name"].startswith("/tmp/dggrid")
+    meta_args.pop("clip_region_files")
+    meta_args.pop("cell_output_file_name")
+    metafile_patched = [f"{key} {val}" for key, val in meta_args.items()]
+
+    assert set(metafile_patched) == {
+        "dggrid_operation GENERATE_GRID",
+        "dggs_type IGEO7",
+        "dggs_proj ISEA",
+        "dggs_aperture 7",
+        "dggs_topology HEXAGON",
+        # NOTE: 'dggs_res_spec' to be inferred from Dggs() attribute, not passing it explicitly to 'specify_resolution'
+        "dggs_res_spec 3",
+        "precision 7",
+        # "clip_region_files /tmp/dggrid/...",
+        # "cell_output_file_name /tmp/dggrid/...",
+        "cell_output_type GDAL",
+        "cell_output_gdal_format FlatGeobuf",
+        "clip_cell_addresses 023",
+        "clip_cell_densification 5",
+        "clip_subset_type COARSE_CELLS",
+        "clip_cell_res 1",
+        # following set explicitly by input parameters
+        "dggs_orient_specify_type SPECIFIED",
+        "dggs_vert0_azimuth 0.0",
+        "dggs_vert0_lat 58.282525588538994675786",
+        "dggs_vert0_lon 11.20",
+        "input_address_type HIERNDX",
+        "output_cell_label_type OUTPUT_ADDRESS_TYPE",
+        "output_address_type HIERNDX",
+        # WARNING: following technically not set by Dggs(), though it probably should for 'IGEO7' ?
+        # "output_hier_ndx_system Z7",
+        # "output_hier_ndx_form DIGIT_STRING",
+        "point_output_type NONE"
+    }