Optionally run dense offsets in InSAR workflow (#766)

* Add boolean parameters in schemas/default for optional execution of dense_offsets

* Check for user preference for dense_offsets execution

* Check for user preference for standalone dense offsets execution

* Set enable flag fr dense offsets True in insar defaults schema

* Remove check on dense offsets enable option in insar_runconfig

* Add comment on defaul value of dense offset enable option

* Remove check on dense offsets enable option in dense offset runconfig

* Consistently change enable flag to enabled in dense_offsets

* Turn off dense offsets in InSAR workflow tests and vary gpu_enabled flag to test both CPU and GPU InSAR workflow.

Co-authored-by: vbrancat <[email protected]>
Co-authored-by: Yang Zheng <[email protected]>

Author: 3 people

python/packages/pybind_nisar/workflows/dense_offsets_runconfig.py

@@ -48,3 +48,4 @@ def yaml_check(self):
                                               frequencies, freq_pols)
         else:
             helpers.check_hdf5_freq_pols(coregistered_slc_path, freq_pols)
+

python/packages/pybind_nisar/workflows/insar.py

@@ -28,7 +28,8 @@ def run(cfg: dict, out_paths: dict, run_steps: dict):
     if run_steps['resample']:
         resample_slc.run(cfg)
 
-    if run_steps['dense_offsets']:
+    if (run_steps['dense_offsets']) and \
+            (cfg['processing']['dense_offsets']['enabled']):
         dense_offsets.run(cfg)
 
     if run_steps['crossmul']:

share/nisar/defaults/insar.yaml

@@ -117,6 +117,8 @@ runconfig:
                 lines_per_tile: 1
 
             dense_offsets:
+                # Flag to enable/disable dense offsets estimation
+                enabled: True
                 # Path to HDF5 file or directory with geometry-coregistered SLCs.
                 # Not required as we allow the use of intermediate outputs from
                 # the previous InSAR module, which is not user-specified

share/nisar/schemas/insar.yaml

@@ -162,6 +162,8 @@ icu_options:
     phase_variance_threshold: num(min=0, required=False)
 
 dense_offsets_options:
+    # Flag to enable/disable dense offsets estimation. Default: True
+    enabled: bool(required=False)
     # Path to HDF5 file or directory with geometry-coregistered SLCs.
     # Not required as we allow the use of intermediate outputs from
     # the previous InSAR module, which is not user-specified

tests/data/insar_test.yaml

@@ -114,6 +114,7 @@ runconfig:
                 lines_per_tile: 1
 
             dense_offsets:
+                enabled: True
                 window_range: 64                                            # {optional} Cross-correlation window size in range direction
                 window_azimuth: 64                                          # {optional} Cross-correlation window size in azimuth direction
                 half_search_range: 20                                       # {optional} Cross-correlation search window size in range direction

tools/imagesets/runconfigs/insar_UAVSAR_NISARP_32039_19049-005_19052-004_129.yaml

@@ -102,16 +102,8 @@ runconfig:
                 lines_per_tile: 100
 
             dense_offsets:
-                window_range: 64                    # {optional} Cross-correlation window size in range direction
-                window_azimuth: 64                  # {optional} Cross-correlation window size in azimuth direction
-                search_range: 20                    # {optional} Cross-correlation search window size in range direction
-                search_azimuth: 20                  # {optional} Cross-correlation search window size in azimuth direction
-                skip_range: 8                       # {optional} Cross-correlation skip window size in range direction
-                skip_azimuth: 8                     # {optional} Cross-correlation skip window in azimuth direction
-                zoom: 8                             # {optional} Zoom in window for cross-correlation surface
-                correlation_surface_ovs: 32         # {optional} Oversampling factor for the cross-correlation surface
-                method: amplitude                   # {optional} Cross-correlation method (complex or amplitude)
-                algorithm: frequency                # {optional} Algorithm for cross-correlation computation (spatial
+                # OPTIONAL - Flag to enable/disable dense offsets estimation. Default True
+                enabled: False
 
             crossmul:
                 flatten: True

tools/imagesets/runconfigs/insar_UAVSAR_SanAnd_05518_12018-000_12128-008_143.yaml

@@ -102,16 +102,8 @@ runconfig:
                 lines_per_tile: 100
 
             dense_offsets:
-                window_range: 64                    # {optional} Cross-correlation window size in range direction
-                window_azimuth: 64                  # {optional} Cross-correlation window size in azimuth direction
-                search_range: 20                    # {optional} Cross-correlation search window size in range direction
-                search_azimuth: 20                  # {optional} Cross-correlation search window size in azimuth direction
-                skip_range: 8                       # {optional} Cross-correlation skip window size in range direction
-                skip_azimuth: 8                     # {optional} Cross-correlation skip window in azimuth direction
-                zoom: 8                             # {optional} Zoom in window for cross-correlation surface
-                correlation_surface_ovs: 32         # {optional} Oversampling factor for the cross-correlation surface
-                method: amplitude                   # {optional} Cross-correlation method (complex or amplitude)
-                algorithm: frequency                # {optional} Algorithm for cross-correlation computation (spatial
+                # OPTIONAL - Flag to enable/disable dense offsets estimation. Default True
+                enabled: False
 
             crossmul:
                 flatten: True
@@ -128,7 +120,7 @@ runconfig:
             internet_access: False
 
             # OPTIONAL - To explicitly use GPU capability if available. Default False
-            gpu_enabled: False
+            gpu_enabled: True
 
         # OPTIONAL - Location to save logs, use runconfig*_yaml.log if not specified
         logging: 

tools/imagesets/runconfigs/insar_UAVSAR_Snjoaq_14511_18034-014_18044-015_143.yaml

@@ -102,16 +102,8 @@ runconfig:
                 lines_per_tile: 100
 
             dense_offsets:
-                window_range: 64                    # {optional} Cross-correlation window size in range direction
-                window_azimuth: 64                  # {optional} Cross-correlation window size in azimuth direction
-                search_range: 20                    # {optional} Cross-correlation search window size in range direction
-                search_azimuth: 20                  # {optional} Cross-correlation search window size in azimuth direction
-                skip_range: 8                       # {optional} Cross-correlation skip window size in range direction
-                skip_azimuth: 8                     # {optional} Cross-correlation skip window in azimuth direction
-                zoom: 8                             # {optional} Zoom in window for cross-correlation surface
-                correlation_surface_ovs: 32         # {optional} Oversampling factor for the cross-correlation surface
-                method: amplitude                   # {optional} Cross-correlation method (complex or amplitude)
-                algorithm: frequency                # {optional} Algorithm for cross-correlation computation (spatial
+                # OPTIONAL - Flag to enable/disable dense offsets estimation. Default True
+                enabled: False
 
             crossmul:
                 flatten: True
@@ -128,7 +120,7 @@ runconfig:
             internet_access: False
 
             # OPTIONAL - To explicitly use GPU capability if available. Default False
-            gpu_enabled: False
+            gpu_enabled: True
 
         # OPTIONAL - Location to save logs, use runconfig*_yaml.log if not specified
         logging: