Add metadata cubes to GSLC and GUNW workflows (#769)

* update GSLC runconfing defaults and schema with the new radar_grid_cubes group

* update InSAR runconfing defaults and schema with the new radar_grid_cubes group

* remove copy from geolocationGrid to radarGrid

* generate radarGrid geogrid when running GSLC and GUNW workflows

* update radarGrid cubes for the GCOV workflow

* add radarGrid cubes to the GSLC workflow

* add radarGrid cubes to the GUNW workflow

Author: gshiroma

python/packages/pybind_nisar/workflows/gcov.py

@@ -89,12 +89,6 @@ def run(cfg):
     # init parameters shared between frequencyA and frequencyB sub-bands
     slc = SLC(hdf5file=input_hdf5)
     dem_raster = isce3.io.Raster(dem_file)
-    native_doppler = slc.getDopplerCentroid()
-    '''
-    bounds error are turned off for the native Doppler because of
-    some issue when computing geo2rdr() in makeRadarGridCubes().
-    ''' 
-    native_doppler.bounds_error = False
     zero_doppler = isce3.core.LUT2d()
     epsg = dem_raster.get_epsg()
     proj = isce3.core.make_projection(epsg)
@@ -378,7 +372,12 @@ def run(cfg):
                 epsg=radar_grid_cubes_geogrid.epsg)
 
             cube_group_name = '/science/LSAR/GCOV/metadata/radarGrid'
-
+            native_doppler = slc.getDopplerCentroid()
+            '''
+            The native-Doppler LUT bounds error is turned off to
+            computer cubes values outside radar-grid boundaries
+            '''
+            native_doppler.bounds_error = False
             add_radar_grid_cubes_to_hdf5(hdf5_obj, cube_group_name, 
                                          cube_geogrid, radar_grid_cubes_heights, 
                                          radar_grid, orbit, native_doppler, 

python/packages/pybind_nisar/workflows/geocode_insar.py

@@ -12,6 +12,7 @@
 import pybind_isce3 as isce3
 from pybind_nisar.products.readers import SLC
 from pybind_nisar.workflows import h5_prep
+from pybind_nisar.workflows.h5_prep import add_radar_grid_cubes_to_hdf5
 from pybind_nisar.workflows.geocode_insar_runconfig import \
     GeocodeInsarRunConfig
 from pybind_nisar.workflows.yaml_argparse import YamlArgparse
@@ -26,6 +27,8 @@ def run(cfg, runw_hdf5, output_hdf5):
     ref_hdf5 = cfg["InputFileGroup"]["InputFilePath"]
     freq_pols = cfg["processing"]["input_subset"]["list_of_frequencies"]
     geogrids = cfg["processing"]["geocode"]["geogrids"]
+    radar_grid_cubes_geogrid = cfg['processing']['radar_grid_cubes']['geogrid']
+    radar_grid_cubes_heights = cfg['processing']['radar_grid_cubes']['heights']
     dem_file = cfg["DynamicAncillaryFileGroup"]["DEMFile"]
     threshold_geo2rdr = cfg["processing"]["geo2rdr"]["threshold"]
     iteration_geo2rdr = cfg["processing"]["geo2rdr"]["maxiter"]
@@ -55,7 +58,8 @@ def run(cfg, runw_hdf5, output_hdf5):
     geo = isce3.geocode.GeocodeFloat32()
 
     # init geocode members
-    geo.orbit = slc.getOrbit()
+    orbit = slc.getOrbit()
+    geo.orbit = orbit
     geo.ellipsoid = ellipsoid
     geo.doppler = grid_zero_doppler
     geo.threshold_geo2rdr = threshold_geo2rdr
@@ -133,6 +137,33 @@ def run(cfg, runw_hdf5, output_hdf5):
 
                     del geocoded_raster
 
+            if freq.upper() == 'B':
+                continue
+
+            # get doppler centroid
+            cube_geogrid = isce3.product.GeoGridParameters(
+                start_x=radar_grid_cubes_geogrid.start_x,
+                start_y=radar_grid_cubes_geogrid.start_y,
+                spacing_x=radar_grid_cubes_geogrid.spacing_x,
+                spacing_y=radar_grid_cubes_geogrid.spacing_y,
+                width=int(radar_grid_cubes_geogrid.width),
+                length=int(radar_grid_cubes_geogrid.length),
+                epsg=radar_grid_cubes_geogrid.epsg)
+
+            cube_group_name = '/science/LSAR/GUNW/metadata/radarGrid'
+
+            native_doppler = slc.getDopplerCentroid(frequency=freq)
+            '''
+            The native-Doppler LUT bounds error is turned off to
+            computer cubes values outside radar-grid boundaries
+            '''
+            native_doppler.bounds_error = False
+            add_radar_grid_cubes_to_hdf5(dst_h5, cube_group_name, 
+                                         cube_geogrid, radar_grid_cubes_heights, 
+                                         radar_grid, orbit, native_doppler, 
+                                         grid_zero_doppler, threshold_geo2rdr, 
+                                         iteration_geo2rdr)
+
     t_all_elapsed = time.time() - t_all
     info_channel.log(f"Successfully ran geocode in {t_all_elapsed:.3f} seconds")
 

python/packages/pybind_nisar/workflows/gslc.py

@@ -9,6 +9,7 @@
 import pybind_isce3 as isce3
 from pybind_nisar.products.readers import SLC
 from pybind_nisar.workflows import h5_prep
+from pybind_nisar.workflows.h5_prep import add_radar_grid_cubes_to_hdf5
 from pybind_nisar.workflows.yaml_argparse import YamlArgparse
 from pybind_nisar.workflows.gslc_runconfig import GSLCRunConfig
 
@@ -22,6 +23,8 @@ def run(cfg):
     output_hdf5 = cfg['ProductPathGroup']['SASOutputFile']
     freq_pols = cfg['processing']['input_subset']['list_of_frequencies']
     geogrids = cfg['processing']['geocode']['geogrids']
+    radar_grid_cubes_geogrid = cfg['processing']['radar_grid_cubes']['geogrid']
+    radar_grid_cubes_heights = cfg['processing']['radar_grid_cubes']['heights']
     dem_file = cfg['DynamicAncillaryFileGroup']['DEMFile']
     threshold_geo2rdr = cfg['processing']['geo2rdr']['threshold']
     iteration_geo2rdr = cfg['processing']['geo2rdr']['maxiter']
@@ -86,6 +89,31 @@ def run(cfg):
                 t_pol_elapsed = time.time() - t_pol
                 info_channel.log(f'polarization {polarization} ran in {t_pol_elapsed:.3f} seconds')
 
+            if freq.upper() == 'B':
+                continue
+
+            cube_geogrid = isce3.product.GeoGridParameters(
+                start_x=radar_grid_cubes_geogrid.start_x,
+                start_y=radar_grid_cubes_geogrid.start_y,
+                spacing_x=radar_grid_cubes_geogrid.spacing_x,
+                spacing_y=radar_grid_cubes_geogrid.spacing_y,
+                width=int(radar_grid_cubes_geogrid.width),
+                length=int(radar_grid_cubes_geogrid.length),
+                epsg=radar_grid_cubes_geogrid.epsg)
+
+            cube_group_name = '/science/LSAR/GSLC/metadata/radarGrid'
+
+            native_doppler.bounds_error = False
+            '''
+            The native-Doppler LUT bounds error is turned off to
+            computer cubes values outside radar-grid boundaries
+            '''
+            add_radar_grid_cubes_to_hdf5(dst_h5, cube_group_name, 
+                                         cube_geogrid, radar_grid_cubes_heights, 
+                                         radar_grid, orbit, native_doppler, 
+                                         image_grid_doppler, threshold_geo2rdr, 
+                                         iteration_geo2rdr)
+
     t_all_elapsed = time.time() - t_all
     info_channel.log(f"successfully ran geocode SLC in {t_all_elapsed:.3f} seconds")
 

python/packages/pybind_nisar/workflows/h5_prep.py

@@ -147,20 +147,6 @@ def cp_geocode_meta(cfg, output_hdf5, dst):
         if is_geocoded:
             cp_h5_meta_data(src_h5, dst_h5, f'{src_meta_path}/attitude',
                             f'{dst_meta_path}/attitude')
-            if dst != 'GCOV':
-                # the lines below should be deleted after radar-grid
-                # cubes are added to all L2 workflows
-                yds = dst_h5.create_dataset(f'{dst_meta_path}/radarGrid/yCoordinates',
-                    data = src_h5[f'{src_meta_path}/geolocationGrid/zeroDopplerTime'])                 
-                xds = dst_h5.create_dataset(f'{dst_meta_path}/radarGrid/xCoodinates',
-                    data = src_h5[f'{src_meta_path}/geolocationGrid/slantRange'])
-                cp_h5_meta_data(src_h5, dst_h5,
-                                f'{src_meta_path}/geolocationGrid',
-                                f'{dst_meta_path}/radarGrid',
-                                renames={'coordinateX': 'slantRange',
-                                         'coordinateY': 'zeroDopplerAzimuthTime'},
-                                excludes=['slantRange', 'zeroDopplerTime'],
-                                attach_scales_list = [yds, xds])
         else:
             # RUNW and RIFG have no attitude group and have geolocation grid
             yds = dst_h5.create_dataset(f'{dst_meta_path}/geolocationGrid/zeroDopplerTime',

python/packages/pybind_nisar/workflows/runconfig.py

@@ -274,5 +274,4 @@ def geocode_common_arg_load(self):
         self.prep_paths()
         self.prep_frequency_and_polarizations()
         self.prep_geocode_cfg()
-        if self.workflow_name == 'gcov':
-            self.prep_cubes_geocode_cfg()
+        self.prep_cubes_geocode_cfg()

share/nisar/defaults/gcov.yaml

@@ -167,7 +167,7 @@ runconfig:
 
             radar_grid_cubes: 
 
-                # # List heights in meters
+                # List of heights in meters
                 heights: 
 
                 # OPTIONAL - Same as the geocode group outputEPSG if not provided

share/nisar/defaults/gslc.yaml

@@ -111,6 +111,41 @@ runconfig:
                     y_abs:
                     x_abs:
 
+            radar_grid_cubes: 
+    
+                # List of heights in meters
+                heights: 
+
+                # OPTIONAL - Same as the geocode group outputEPSG if not provided
+                outputEPSG:
+
+                # OPTIONAL - Spacing between pixels, in same units as output EPSG.
+                # If not provided, spacing values will be taken from geocode group
+                # parameters.
+                # All postings/spacings must be > 0.
+                # ISCE3 output rasters always have North-up West-left orientation
+                output_posting:
+                    x_posting: 
+                    y_posting: 
+
+                # OPTIONAL - To control output grid in same units as output EPSG
+                y_snap:
+
+                # OPTIONAL - To control output grid in same units as output EPSG
+                x_snap:
+
+                # OPTIONAL - Can control with absolute values or with snap values
+                top_left:        
+                    # OPTIONAL - Set top-left y in same units as output EPSG
+                    y_abs:
+                    # OPTIONAL - Set top-left x in same units as output EPSG
+                    x_abs:
+
+                # OPTIONAL - Can control with absolute values or with snap values
+                bottom_right:
+                    y_abs:
+                    x_abs:  
+
             geo2rdr:
                 threshold: 1.0e-8
                 maxiter: 25

share/nisar/defaults/insar.yaml

@@ -103,6 +103,41 @@ runconfig:
                     y_abs:
                     x_abs:
 
+            radar_grid_cubes: 
+    
+                # List of heights in meters
+                heights: 
+
+                # OPTIONAL - Same as the geocode group outputEPSG if not provided
+                outputEPSG:
+
+                # OPTIONAL - Spacing between pixels, in same units as output EPSG.
+                # If not provided, spacing values will be taken from geocode group
+                # parameters.
+                # All postings/spacings must be > 0.
+                # ISCE3 output rasters always have North-up West-left orientation
+                output_posting:
+                    x_posting: 
+                    y_posting: 
+
+                # OPTIONAL - To control output grid in same units as output EPSG
+                y_snap:
+
+                # OPTIONAL - To control output grid in same units as output EPSG
+                x_snap:
+
+                # OPTIONAL - Can control with absolute values or with snap values
+                top_left:        
+                    # OPTIONAL - Set top-left y in same units as output EPSG
+                    y_abs:
+                    # OPTIONAL - Set top-left x in same units as output EPSG
+                    x_abs:
+
+                # OPTIONAL - Can control with absolute values or with snap values
+                bottom_right:
+                    y_abs:
+                    x_abs:  
+
             geo2rdr:
                 # No topo_path provided. Default to ScratchPath.
                 threshold: 1.0e-8

share/nisar/schemas/gcov.yaml

@@ -178,7 +178,7 @@ runconfig:
 ---
 radar_grid_cubes_options:
 
-    # List heights in meters
+    # List of heights in meters
     heights: list(num(), required=False)
 
     # Same as input DEM if not provided.

share/nisar/schemas/gslc.yaml

@@ -98,6 +98,8 @@ runconfig:
                     # Set bottom-right x in same units as output EPSG
                     x_abs: num(required=False)
 
+            radar_grid_cubes:  include('radar_grid_cubes_options', required=False)
+
             geo2rdr: include('geo2rdr_options', required=False)
 
             blocksize:
@@ -123,6 +125,40 @@ runconfig:
         logging: include('log_nfo', required=False)
 
 ---
+radar_grid_cubes_options:
+
+    # List of heights in meters
+    heights: list(num(), required=False)
+
+    # Same as input DEM if not provided.
+    outputEPSG: int(min=1024, max=32767, required=False)
+               
+    # Output posting in same units as output EPSG.
+    # If not provided, spacing values will be taken from provided DEM.
+    output_posting:
+        x_posting: num(min=0, required=False)
+        y_posting: num(min=0, required=False)
+
+    # To control output grid in same units as output EPSG
+    x_snap: num(min=0, required=False)
+               
+    # To control output grid in same units as output EPSG
+    y_snap: num(min=0, required=False)
+               
+    top_left:    
+        # Set top-left y in same units as output EPSG
+        y_abs: num(required=False)
+       
+        # Set top-left x in same units as output EPSG
+        x_abs: num(required=False)
+               
+    bottom_right:  
+        # Set bottom-right y in same units as output EPSG
+        y_abs: num(required=False)
+       
+        # Set bottom-right x in same units as output EPSG
+        x_abs: num(required=False)
+
 
 geo2rdr_options:
     threshold: num(min=1.0e-9, max=1.0e-3, required=False)