excluded polarzation not used for subband SLC HDF5

Author: jungkyoJung

python/packages/nisar/workflows/split_spectrum.py

@@ -16,21 +16,74 @@
 from nisar.workflows.yaml_argparse import YamlArgparse
 
 
+def prep_subband_h5(full_hdf5: str, 
+                    sub_band_hdf5: str, 
+                    freq_pols):
+
+    common_parent_path = 'science/LSAR'
+    swath_path = f'{common_parent_path}/SLC/swaths/'
+    freq_a_path = f'{swath_path}/frequencyA/'
+    freq_b_path = f'{swath_path}/frequencyB/'
+    metadata_path = f'{common_parent_path}/SLC/metadata/'
+    ident_path = f'{common_parent_path}/identification/'
+    pol_a_path = f'{freq_a_path}/listOfPolarizations'
+    pol_b_path = f'{freq_b_path}/listOfPolarizations'
+        
+    with h5py.File(full_hdf5, 'r', libver='latest', swmr=True) as src_h5, \
+        h5py.File(sub_band_hdf5, 'w') as dst_h5:
+            
+        pols_freqA = list(
+                np.array(src_h5[pol_a_path][()], dtype=str))
+        pols_freqB = list(
+                np.array(src_h5[pol_b_path][()], dtype=str))
+        
+        if freq_pols['A']:
+            pols_a_excludes = [pol for pol in pols_freqA 
+                if pol not in freq_pols['A']]
+        else:
+            pols_a_excludes = pols_freqA
+
+        if freq_pols['B']:
+            pols_b_excludes = [pol for pol in pols_freqB 
+                if pol not in freq_pols['B']]
+        else:
+            pols_b_excludes = pols_freqB
+
+        if pols_a_excludes:
+            cp_h5_meta_data(src_h5, dst_h5, freq_a_path,
+                    excludes=pols_a_excludes)
+        else:
+            cp_h5_meta_data(src_h5, dst_h5, freq_a_path,
+                    excludes=[''])
+            
+        if pols_b_excludes:
+            cp_h5_meta_data(src_h5, dst_h5, freq_b_path,
+                    excludes=pols_b_excludes)
+        else:
+            cp_h5_meta_data(src_h5, dst_h5, freq_b_path,
+                    excludes=[''])
+
+        cp_h5_meta_data(src_h5, dst_h5, metadata_path,
+                    excludes=[''])
+        cp_h5_meta_data(src_h5, dst_h5, ident_path,
+                    excludes=[''])
+        cp_h5_meta_data(src_h5, dst_h5, swath_path,
+                    excludes=['frequencyA', 'frequencyB'])   
+
 def run(cfg: dict):
     '''
     run bandpass
     '''
     # pull parameters from cfg
     ref_hdf5 = cfg['input_file_group']['input_file_path']
     sec_hdf5 = cfg['input_file_group']['secondary_file_path']
-    freq_pols = cfg['processing']['input_subset']['list_of_frequencies']
 
     # Extract range split spectrum dictionary and corresponding parameters
     ionosphere_option = cfg['processing']['ionosphere_phase_correction']
+    method = ionosphere_option['spectral_diversity']
     split_cfg = ionosphere_option['split_range_spectrum']
     iono_freq_pol = ionosphere_option['list_of_frequencies']
     blocksize = split_cfg['lines_per_block']
-    method = split_cfg['spectral_diversity']
     window_function = split_cfg['window_function']
     window_shape = split_cfg['window_shape']
     low_band_bandwidth = split_cfg['low_band_bandwidth']
@@ -51,7 +104,7 @@ def run(cfg: dict):
 
         common_parent_path = 'science/LSAR'
         freq = 'A'
-
+        print('test', iono_freq_pol)
         pol_list = iono_freq_pol[freq]
         info_channel.log(f'Split the main band {pol_list} of the signal')
 
@@ -93,12 +146,17 @@ def run(cfg: dict):
 
             dest_freq_path = os.path.join(slc_product.SwathPath,
                                           f'frequency{freq}')
+
+            # prepare HDF5 for subband SLC HDF5
+            prep_subband_h5(hdf5_str, low_band_output, iono_freq_pol)
+            prep_subband_h5(hdf5_str, high_band_output, iono_freq_pol)
+
             with h5py.File(hdf5_str, 'r', libver='latest', swmr=True) as src_h5, \
-                    h5py.File(low_band_output, 'w') as dst_h5_low, \
-                    h5py.File(high_band_output, 'w') as dst_h5_high:
+                    h5py.File(low_band_output, 'r+') as dst_h5_low, \
+                    h5py.File(high_band_output, 'r+') as dst_h5_high:
                 # Copy HDF5 metadata for low high band
-                cp_h5_meta_data(src_h5, dst_h5_low, f'{common_parent_path}')
-                cp_h5_meta_data(src_h5, dst_h5_high, f'{common_parent_path}')
+                # cp_h5_meta_data(src_h5, dst_h5_low, f'{common_parent_path}')
+                # cp_h5_meta_data(src_h5, dst_h5_high, f'{common_parent_path}')
                 for pol in pol_list:
                     raster_str = f'HDF5:{hdf5_str}:/{slc_product.slcPath(freq, pol)}'
                     slc_raster = isce3.io.Raster(raster_str)

python/packages/nisar/workflows/split_spectrum_runconfig.py

@@ -32,7 +32,7 @@ def yaml_check(self):
         iono_freq_pol = iono_cfg['list_of_frequencies']
         ref_slc_path = self.cfg['input_file_group']['input_file_path']
         sec_slc_path = self.cfg['input_file_group']['secondary_file_path']
-        iono_method = split_cfg['spectral_diversity']
+        iono_method = iono_cfg['spectral_diversity']
 
         # Extract main range bandwidth from reference RSLC
         ref_slc = SLC(hdf5file=ref_slc_path)
@@ -66,7 +66,7 @@ def yaml_check(self):
 
         # Depending on how the user has selected "spectral_diversity" check if
         # "low_bandwidth" and "high_bandwidth" are assigned. Otherwise, use default
-        if split_cfg['spectral_diversity'] == 'split_main_band':
+        if iono_method == 'split_main_band':
             # If "low_bandwidth" or 'high_bandwidth" is not allocated, 
             # split the main range bandwidth into two 1/3 sub-bands.
             if split_cfg['low_band_bandwidth'] is None or split_cfg[
@@ -103,11 +103,11 @@ def yaml_check(self):
                 # Co-polarizations are found, split_main_band will be used for co-pols
                 common_copol_ref_sec = [pol for pol in common_pol_refsec_freqA 
                     if pol in ['VV', 'HH']]
-                iono_freq_pol = {'A': common_copol_ref_sec}
+                iono_freq_pol['A'] = common_copol_ref_sec
 
                 # If common co-pols not found, cross-pol will be alternatively used.
                 if not common_copol_ref_sec:
-                    iono_freq_pol = {'A': common_pol_refsec_freqA}
+                    iono_freq_pol['A'] = common_pol_refsec_freqA
                 info_str = f"{iono_freq_pol} will be used for split_main_band"
                 info_channel.log(info_str)
                 self.cfg['processing'][

share/nisar/defaults/insar.yaml

@@ -151,12 +151,12 @@ runconfig:
 
             ionosphere_phase_correction:
                 enabled: False
+                spectral_diversity: split_main_band
                 list_of_frequencies:
                    A: 
                    B: 
                 split_range_spectrum:
                    lines_per_block: 1000
-                   spectral_diversity: split_main_band
                    low_band_bandwidth:
                    high_band_bandwidth:
                    window_function: tukey

share/nisar/schemas/insar.yaml

@@ -496,11 +496,6 @@ bandpass_options:
 split_range_spectrum_options:
     # Number of lines per block for block processing)
     lines_per_block: int(min=1, required=False)
-    # 'split_main_band' splits the main range bandwidth into a low and high subband
-    # being 1/3 (fixed for now) of the total main range spectrum.
-    # 'main_side_band' uses the additional NISAR 5 MHz side-band to estimate the
-    # ionosphere phase screen. Main and side-bands are intended to be at the same polarization
-    spectral_diversity: enum('split_main_band', 'main_side_band', 'main_diff_main_side_band', required=False)
     # Low bandwidth. If unspecified is automatically set by the workflow according to
     # the selected spectral diversity
     low_band_bandwidth: num(min=0, required=False)
@@ -515,6 +510,11 @@ split_range_spectrum_options:
 ionosphere_phase_correction_options:
     # Boolean flag to enable/disable ionosphere phase correction
     enabled: bool(required=False)
+    # 'split_main_band' splits the main range bandwidth into a low and high subband
+    # being 1/3 (fixed for now) of the total main range spectrum.
+    # 'main_side_band' uses the additional NISAR 5 MHz side-band to estimate the
+    # ionosphere phase screen. Main and side-bands are intended to be at the same polarization
+    spectral_diversity: enum('split_main_band', 'main_side_band', 'main_diff_main_side_band', required=False)
     split_range_spectrum: include('split_range_spectrum_options', required=False)
     list_of_frequencies: include('ionosphere_freq_pol_options', required=False)