Adding Ionosphere Phase Estimation

README.md

@@ -49,6 +49,19 @@ This is reflected in the [`sample_run.sh`](sample_run.sh).
 
 To be even more explicity, you can use [`tee`](https://en.wikipedia.org/wiki/Tee_(command)) to record output to both including `> >(tee -a topsapp_img.out) 2> >(tee -a topsapp_img.err >&2)`.
 
+### Customizations
+
+#### Estimating Ionospheric Phase Delay
+
+This example shows how to obtain a layer with ionsopheric phase delay. The SLCs are over the Arabian peninusula where the ionosphere can be seen:
+
+```
+isce2_topsapp --reference-scenes S1A_IW_SLC__1SDV_20221002T151520_20221002T151543_045265_056931_E517 \
+              --secondary-scenes S1A_IW_SLC__1SDV_20220908T151520_20220908T151542_044915_055D68_78EC \
+              --estimate-ionosphere-delay True \
+              > topsapp_img.out 2> topsapp_img.err
+```
+
 # Running with Docker (locally or on a server)
 
 1. When running locally with root privileges (i.e. at your local workstation), build the docker image using:

isce2_topsapp/__main__.py

@@ -88,6 +88,7 @@ def gunw_slc():
     parser.add_argument('--dry-run', action='store_true')
     parser.add_argument('--reference-scenes', type=str.split, nargs='+', required=True)
     parser.add_argument('--secondary-scenes', type=str.split, nargs='+', required=True)
+    parser.add_argument('--estimate-ionosphere-delay', type=bool, default=False)
     args = parser.parse_args()
 
     ensure_earthdata_credentials(args.username, args.password)
@@ -110,9 +111,10 @@ def gunw_slc():
                        secondary_slc_zips=loc_data['sec_paths'],
                        orbit_directory=loc_data['orbit_directory'],
                        extent=loc_data['extent'],
+                       estimate_ionosphere_delay=args.estimate_ionosphere_delay,
                        dem_for_proc=loc_data['full_res_dem_path'],
                        dem_for_geoc=loc_data['low_res_dem_path'],
-                       dry_run=args.dry_run
+                       dry_run=args.dry_run,
                        )
 
     ref_properties = loc_data['reference_properties']
@@ -146,6 +148,7 @@ def gunw_burst():
     parser.add_argument('--burst-number', type=int, required=True)
     parser.add_argument('--azimuth-looks', type=int, default=2)
     parser.add_argument('--range-looks', type=int, default=10)
+    parser.add_argument('--estimate-ionosphere-delay', type=bool, default=False)
     args = parser.parse_args()
 
     ensure_earthdata_credentials(args.username, args.password)
@@ -184,6 +187,7 @@ def gunw_burst():
         extent=roi,
         dem_for_proc=dem['full_res_dem_path'],
         dem_for_geoc=dem['low_res_dem_path'],
+        estimate_ionosphere_delay=args.estimate_ionosphere_delay,
         azimuth_looks=args.azimuth_looks,
         range_looks=args.range_looks,
         swaths=[ref_burst.swath],

isce2_topsapp/templates/topsapp_template.xml

@@ -22,9 +22,11 @@
     <property name="geocodeDemFilename">{{ geocodeDemFilename }}</property>
     <property name="do unwrap">True</property>
     <property name="unwrapper name">snaphu_mcf</property>
+    <property name="do ionospheric phase estimation">{{ estimate_ionosphere_delay }}</property>
+    <property name="apply ionospheric phase correction">False</property>
     <property name="do ESD">{{ do_esd }}</property>
     <property name="ESD coherence threshold">{{ esd_coherence_threshold }}</property>
     <property name="use virtual files">{{ use_virtual_files }}</property>
-    <property name="geocode list">['merged/phsig.cor', 'merged/filt_topophase.unw', 'merged/los.rdr', 'merged/topophase.flat', 'merged/filt_topophase.flat', 'merged/filt_topophase_2stage.unw', 'merged/topophase.cor', 'merged/filt_topophase.unw.conncomp']</property>
+    <property name="geocode list">{{ geocode_list }}</property>
   </component>
 </topsApp>

isce2_topsapp/topsapp_proc.py

@@ -25,6 +25,15 @@
 
 TEMPLATE_DIR = Path(__file__).parent/'templates'
 
+GEOCODE_LIST_BASE = ['merged/phsig.cor',
+                     'merged/filt_topophase.unw',
+                     'merged/los.rdr',
+                     'merged/topophase.flat',
+                     'merged/filt_topophase.flat',
+                     'merged/filt_topophase_2stage.unw',
+                     'merged/topophase.cor',
+                     'merged/filt_topophase.unw.conncomp']
+
 
 def topsapp_processing(*,
                        reference_slc_zips: list,
@@ -33,6 +42,7 @@ def topsapp_processing(*,
                        extent: list,
                        dem_for_proc: str,
                        dem_for_geoc: str,
+                       estimate_ionosphere_delay: bool,
                        azimuth_looks: int = 7,
                        range_looks: int = 19,
                        swaths: list = None,
@@ -49,6 +59,10 @@ def topsapp_processing(*,
     with open(TEMPLATE_DIR/'topsapp_template.xml', 'r') as file:
         template = Template(file.read())
 
+    geocode_list = GEOCODE_LIST_BASE.copy()
+    if estimate_ionosphere_delay:
+        geocode_list.append('merged/topophase.ion')
+
     topsApp_xml = template.render(orbit_directory=orbit_directory,
                                   output_reference_directory='reference',
                                   output_secondary_directory='secondary',
@@ -62,9 +76,11 @@ def topsapp_processing(*,
                                   do_unwrap=True,
                                   use_virtual_files=True,
                                   esd_coherence_threshold=-1,
+                                  estimate_ionosphere_delay=estimate_ionosphere_delay,
                                   azimuth_looks=azimuth_looks,
                                   range_looks=range_looks,
-                                  swaths=swaths
+                                  swaths=swaths,
+                                  geocode_list=geocode_list
                                   )
     with open('topsApp.xml', "w") as file:
         file.write(topsApp_xml)