Expose interpolation options to GCOV SAS (#743)

* add interp options to GCOV runconfig YAMLs and to GCOV SAS

* add algorithms/demInterpolation dataset to GCOV products

* update convertion of the DEM interp method string to enum

* update convertion of the DEM interp method string to enum (2)

* move enum declaration of Geocoding parameters from gcov.py to gcov_runconfig.py; move the setting of geocoding HDF5 parameters to h5_prep.py

* move enum declaration of Geocoding parameters from gcov.py to gcov_runconfig.py; move the setting of geocoding HDF5 parameters to h5_prep.py (2)

* Update python/packages/pybind_nisar/workflows/h5_prep.py

Co-Authored-By: Liang Yu <[email protected]>

* Update python/packages/pybind_nisar/workflows/gcov_runconfig.py

Co-Authored-By: Liang Yu <[email protected]>

* Update python/packages/pybind_nisar/workflows/h5_prep.py (2)

Co-authored-by: Liang Yu <[email protected]>

Author: 2 people

python/packages/pybind_nisar/workflows/gcov.py

@@ -36,12 +36,15 @@ def run(cfg):
     radar_grid_cubes_geogrid = cfg['processing']['radar_grid_cubes']['geogrid']
     radar_grid_cubes_heights = cfg['processing']['radar_grid_cubes']['heights']
 
+    # DEM parameters
     dem_file = cfg['DynamicAncillaryFileGroup']['DEMFile']
     dem_margin = cfg['processing']['dem_margin']
+    dem_interp_method_enum = cfg['processing']['dem_interpolation_method_enum']
 
     # unpack geocode run parameters
     geocode_dict = cfg['processing']['geocode']
-    output_mode = geocode_dict['algorithm_type']
+    geocode_algorithm = geocode_dict['algorithm_type']
+    output_mode = geocode_dict['output_mode']
     flag_apply_rtc = geocode_dict['apply_rtc']
     memory_mode = geocode_dict['memory_mode']
     geogrid_upsampling = geocode_dict['geogrid_upsampling']
@@ -155,6 +158,10 @@ def run(cfg):
         geo.numiter_geo2rdr = maxiter
         geo.dem_block_margin = dem_margin
 
+        # set data interpolator based on the geocode algorithm
+        if output_mode == isce3.geocode.GeocodeOutputMode.INTERP:
+            geo.data_interpolator = geocode_algorithm
+
         geo.geogrid(geogrid.start_x, geogrid.start_y,
                     geogrid.spacing_x, geogrid.spacing_y,
                     geogrid.width, geogrid.length, geogrid.epsg)
@@ -247,6 +254,7 @@ def run(cfg):
                     out_geo_dem=out_geo_dem_obj,
                     input_rtc=None,
                     output_rtc=None,
+                    dem_interp_method=dem_interp_method_enum,
                     memory_mode=memory_mode)
 
         del output_raster_obj

python/packages/pybind_nisar/workflows/gcov_runconfig.py

@@ -49,10 +49,13 @@ def load(self):
         else:
             rtc_dict['output_type'] = isce.geometry.RtcOutputTerrainRadiometry.GAMMA_NAUGHT
 
-        if geocode_dict['algorithm_type'] == 'interp':
-            geocode_dict['algorithm_type'] = isce.geocode.GeocodeOutputMode.INTERP
+
+        geocode_algorithm = self.cfg['processing']['geocode']['algorithm_type']
+        if geocode_algorithm == "area_projection":
+            output_mode = isce.geocode.GeocodeOutputMode.AREA_PROJECTION
         else:
-            geocode_dict['algorithm_type'] = isce.geocode.GeocodeOutputMode.AREA_PROJECTION
+            output_mode = isce.geocode.GeocodeOutputMode.INTERP
+        geocode_dict['output_mode'] = output_mode
 
         # only 2 RTC algorithms supported: area_projection (default) & bilinear_distribution
         if rtc_dict['algorithm_type'] == "bilinear_distribution":
@@ -77,3 +80,25 @@ def load(self):
             dem_raster = isce.io.Raster(dem_file)
             dem_margin = 50 * max([dem_raster.dx, dem_raster.dy])
             self.cfg['processing']['dem_margin'] = dem_margin
+
+        # Update the DEM interpolation method
+        dem_interp_method = \
+            self.cfg['processing']['dem_interpolation_method']
+
+        if dem_interp_method == 'biquintic':
+            dem_interp_method_enum = isce.core.DataInterpMethod.BIQUINTIC
+        elif (dem_interp_method == 'sinc'):
+            dem_interp_method_enum = isce.core.DataInterpMethod.SINC
+        elif (dem_interp_method == 'bilinear'):
+            dem_interp_method_enum = isce.core.DataInterpMethod.BILINEAR
+        elif (dem_interp_method == 'bicubic'):
+            dem_interp_method_enum = isce.core.DataInterpMethod.BICUBIC
+        elif (dem_interp_method == 'nearest'):
+            dem_interp_method_enum = isce.core.DataInterpMethod.NEAREST
+        else:
+            err_msg = ('ERROR invalid DEM interpolation method:'
+                       f' {dem_interp_method}')
+            raise ValueError(err_msg)
+
+        self.cfg['processing']['dem_interpolation_method_enum'] = \
+            dem_interp_method_enum

python/packages/pybind_nisar/workflows/h5_prep.py

@@ -93,6 +93,13 @@ def cp_geocode_meta(cfg, output_hdf5, dst):
     if is_insar:
         secondary_hdf5 = cfg['InputFileGroup']['SecondaryFilePath']
 
+    if dst == "GCOV":
+        dem_interp_method = cfg['processing']['dem_interpolation_method']
+        geocode_algorithm = cfg['processing']['geocode']['algorithm_type']
+    else:
+        dem_interp_method = None
+        geocode_algorithm = None
+
     # Remove existing HDF5 and start from scratch
     try:
         os.remove(output_hdf5)
@@ -160,6 +167,17 @@ def cp_geocode_meta(cfg, output_hdf5, dst):
                         f'{src_meta_path}/processingInformation/algorithms',
                         f'{dst_meta_path}/processingInformation/algorithms')
 
+        if dst == "GCOV":
+            algorithms_ds = (dst_meta_path +
+                             'processingInformation/algorithms/geocoding')
+            dst_h5.require_dataset(algorithms_ds, (), "S27", 
+                data=np.string_(geocode_algorithm))
+
+            algorithms_ds = (dst_meta_path +
+                             'processingInformation/algorithms/demInterpolation')
+            dst_h5.require_dataset(algorithms_ds, (), "S27", 
+                data=np.string_(dem_interp_method))
+
         # copy processingInformation/inputs group
         exclude_args = ['l0bGranules', 'demFiles']
         if not is_geocoded:

share/nisar/defaults/gcov.yaml

@@ -206,6 +206,8 @@ runconfig:
 
             dem_margin:
 
+            dem_interpolation_method: biquintic
+
             # OPTIONAL - if noise correction desired (for ISRO)
             noise_correction:
                 # OPTIONAL -

share/nisar/schemas/gcov.yaml

@@ -79,12 +79,12 @@ runconfig:
 
             # Mechanism to specify output posting and DEM
             geocode:
-                algorithm_type: enum('area_projection', 'interp', required=False)
+                algorithm_type: enum('area_projection', 'sinc', 'bilinear', 'bicubic', 'nearest', 'biquintic', required=False)
 
                 # Apply RTC
                 apply_rtc: bool(required=False)
 
-                memory_mode: enum('auto', 'single_block', 'BLOCKS_GEOGRID', 'BLOCKS_GEOGRID_AND_RADARGRID', required=False)
+                memory_mode: enum('auto', 'single_block', 'blocks_geogrid', 'blocks_geogrid_and_radargrid', required=False)
 
                 # Processing upsampling factor on top of the input geogrid
                 geogrid_upsampling: int(required=False)
@@ -149,7 +149,9 @@ runconfig:
             geo2rdr:      include('geo2rdr_options', required=False)
 
             dem_margin: num(required=False)
-        
+
+            dem_interpolation_method: enum('sinc', 'bilinear', 'bicubic', 'nearest', 'biquintic', required=False)
+
             # If noise correction desired (for ISRO)
             noise_correction:
                 apply_correction: bool(required=False)