[gamma] compatibility with GAMMA version 20250625

Author: johntruckenbrodt

pyroSAR/gamma/parser.py

@@ -58,11 +58,17 @@ def parse_command(command, indent='    '):
         # for all other commands stderr is just appended to stdout
         out += err
 
-    warning = None
-    pattern = r'([\w\.]+ (?:has been|was) re(?:named to|placed(?: that [ \*\n]*|) by)(?: the ISP program|) [\w\.]+)'
-    match = re.search(pattern, out)
-    if match:
-        warning = "raise DeprecationWarning('{}')".format(match.group())
+    # raise a warning when the command has been deprecated
+    # extract all lines starting and ending with three asterisks
+    matches = re.findall(r'^\*{3}\s*(.*?)\s*\*{3}$', out, re.MULTILINE)
+    if matches:
+        # join the lines and search for a deprecation message
+        cleaned = ' '.join(matches)
+        pattern = (r'([\w\.]+ (?:has been|was) re(?:named to|placed(?: that [ \*\n]*|) by)'
+                   r'(?:[ \*\n]*|)(?: the ISP program|) [\w\.]+)')
+        match = re.search(pattern, cleaned)
+        if match:
+            raise DeprecationWarning(match.group())
 
     if re.search(r"Can't locate FILE/Path\.pm in @INC", out):
         raise RuntimeError('unable to parse Perl script')
@@ -139,6 +145,8 @@ def parse_command(command, indent='    '):
                        'mk_base_calc': [('<RSLC_tab>', '<SLC_tab>')],
                        'mk_cpd_all': [('dtab', 'data_tab')],
                        'mk_cpx_ref_2d': [('diff_tab', 'cpx_tab')],
+                       'mk_diff_tc_2d': [('<def>', '<def_rate>'),
+                                         ('def       (input)', 'def_rate  (input)')],
                        'mk_dispmap2_2d': [('RMLI_image', 'MLI'),
                                           ('RMLI_par', 'MLI_par'),
                                           ('MLI_image', 'MLI'),
@@ -166,6 +174,7 @@ def parse_command(command, indent='    '):
                                         ('MLI_image', 'MLI')],
                        'mk_rasmph_all': [('RMLI_image', 'MLI'),
                                          ('MLI_image', 'MLI')],
+                       'mk_tab2': [('--linenumber', 'linenumber')],
                        'mk_unw_2d': [('unw_mask1', 'unw_mask')],
                        'mk_unw_ref_2d': [('diff_tab', 'DIFF_tab')],
                        'MLI2pt': [('MLI_TAB', 'MLI_tab'),
@@ -358,9 +367,6 @@ def replace(inlist, replacement):
     if command_base in replacements.keys():
         arg_req = replace(arg_req, replacements[command_base])
         arg_opt = replace(arg_opt, replacements[command_base])
-    
-    if command_base in ['par_CS_geo', 'par_KS_geo']:
-        out = re.sub('[ ]*trunk.*', '', out, flags=re.DOTALL)
     ###########################################
     # check if there are any double parameters
 
@@ -379,22 +385,23 @@ def replace(inlist, replacement):
     ######################################################################################
     # create the function argument string for the Python function
 
-    # optional arguments are parametrized with '-' as default value, e.g. arg_opt='-'
+    # optional arguments are parametrized with '-' as default value, e.g., arg_opt='-'
+    argstr_function = ', '.join(arg_req + [x + "='-'" for x in arg_opt])
     # a '-' in the parameter name is replaced with '_'
-    # example: "arg1, arg2, arg3='-'"
-    argstr_function = re.sub(r'([^\'])-([^\'])', r'\1_\2', ', '.join(arg_req + [x + "='-'" for x in arg_opt])) \
-        .replace(', def=', ', drm=')
+    argstr_function = re.sub(r'([^\'])-([^\'])', r'\1_\2', argstr_function)
+    # replace unsupported 'def' parameter name with 'drm'
+    argstr_function = argstr_function.replace(', def=', ', drm=')
 
     # some commands have different defaults than '-'
     replacements_defaults = {'S1_import_SLC_from_zipfiles': {'OPOD_dir': '.'}}
 
     if command_base in replacements_defaults.keys():
         for key, value in replacements_defaults[command_base].items():
-            old = "{}='-'".format(key)
+            old = f"{key}='-'"
             if isinstance(value, str):
-                new = "{0}='{1}'".format(key, value)
+                new = f"{key}='{value}'"
             else:
-                new = "{0}={1}".format(key, value)
+                new = f"{key}={value}"
             argstr_function = argstr_function.replace(old, new)
 
     # create the function definition string
@@ -417,12 +424,13 @@ def replace(inlist, replacement):
                                    ('max', '-b', None),
                                    ('rmax', '-R', None),
                                    ('mode', '-m', None),
-                                   ('update', '-u', False)]}
+                                   ('update', '-u', False)],
+                 'mk_tab2': [('linenumber', '--linenumber', False)]}
 
     # replace arg default like arg='-' with arg=None or arg=False
     if command_base in flag_args:
         for arg in flag_args[command_base]:
-            fun_def = re.sub('{}=\'-\''.format(arg[0]), '{0}={1}'.format(arg[0], arg[2]), fun_def)
+            fun_def = re.sub(f'{arg[0]}=\'-\'', f'{arg[0]}={arg[2]}', fun_def)
     ######################################################################################
     # create the process call argument string
 
@@ -440,7 +448,7 @@ def replace(inlist, replacement):
         key = replacements[command_base][0][1]
         if isinstance(key, list):
             key = key[0]
-        proc_args_tmp.insert(proc_args_tmp.index(key), 'len({})'.format(key))
+        proc_args_tmp.insert(proc_args_tmp.index(key), f'len({key})')
 
     if command_base == 'validate':
         index = proc_args_tmp.index('classes_inv')
@@ -469,10 +477,7 @@ def replace(inlist, replacement):
     # create the process call string
     proc_str = "process(cmd, logpath=logpath, outdir=outdir{inlist}, shellscript=shellscript)" \
         .format(inlist=', inlist=inlist' if command_base in inlist else '')
-    if warning is not None:
-        fun_proc = warning
-    else:
-        fun_proc = '{0}\n{1}'.format(cmd_str, proc_str)
+    fun_proc = '{0}\n{1}'.format(cmd_str, proc_str)
 
     if command_base == 'lin_comb_cpx':
         fun_proc = fun_proc.replace('factors_r, factors_i', 'zip(factors_r, factors_i)')
@@ -564,7 +569,7 @@ def replace(inlist, replacement):
         description = re.split(r'\n+\s*', description.strip('\n'))
 
         # escape * characters (which are treated as special characters for bullet lists by sphinx)
-        description = [x.replace('*', r'\*') for x in description]
+        description = [x.replace('*', r'\\*') for x in description]
 
         # convert all lines starting with an integer number or 'NOTE' to bullet list items
         latest = None
@@ -652,7 +657,7 @@ def parse_module(bindir, outfile):
 
     excludes = ['coord_trans',  # doesn't take any parameters and is interactive
                 'RSAT2_SLC_preproc',  # takes option flags
-                'mk_ASF_CEOS_list',  # "cannot create : Directory nonexistent"
+                'mk_ASF_CEOS_list',  # "cannot create: Directory nonexistent"
                 '2PASS_UNW',  # parameter name inconsistencies
                 'mk_diff_2d',  # takes option flags
                 'gamma_doc'  # opens the Gamma documentation
@@ -680,8 +685,8 @@ def parse_module(bindir, outfile):
         with open(outfile, 'a') as out:
             out.write(outstring)
     if len(failed) > 0:
-        log.info(
-            'the following functions could not be parsed:\n{0}\n({1} total)'.format('\n'.join(failed), len(failed)))
+        info = 'the following functions could not be parsed:\n{0}\n({1} total)'
+        log.info(info.format('\n'.join(failed), len(failed)))
 
 
 def autoparse():

pyroSAR/gamma/util.py

@@ -835,9 +835,9 @@ def geocode(scene, dem, tmpdir, outdir, spacing, scaling='linear', func_geoback=
 
     reference_par = ISPPar(reference + '.par')
     ######################################################################
-    # DEM product generation #############################################
+    # geocoding and DEM product generation ###############################
     ######################################################################
-    log.info('creating DEM products')
+    log.info('geocoding and creating DEM products')
     gc_map_wrap(image=reference, namespace=n, dem=dem, spacing=spacing, exist_ok=exist_ok,
                 logpath=path_log, outdir=tmpdir, shellscript=shellscript)
 
@@ -850,7 +850,7 @@ def geocode(scene, dem, tmpdir, outdir, spacing, scaling='linear', func_geoback=
                     logpath=path_log, outdir=tmpdir, shellscript=shellscript)
 
     ######################################################################
-    # lookup table Refinement ############################################
+    # lookup table refinement ############################################
     ######################################################################
     lut_final = n.lut_init
     if refine_lut:
@@ -864,7 +864,7 @@ def geocode(scene, dem, tmpdir, outdir, spacing, scaling='linear', func_geoback=
                              logpath=path_log,
                              outdir=tmpdir,
                              shellscript=shellscript)
-        # Refinement Lookuptable
+        # Refinement of lookup table
         # for "shift" data offset window size enlarged twice to 512 and 256, for data without shift 256 128
         diff.offset_pwrm(MLI_1=n.pix_area_sigma0,
                          MLI_2=reference,
@@ -906,9 +906,9 @@ def geocode(scene, dem, tmpdir, outdir, spacing, scaling='linear', func_geoback=
                         logpath=path_log, outdir=tmpdir, shellscript=shellscript)
         lut_final = lut_final + '.fine'
     ######################################################################
-    # radiometric terrain correction and backward geocoding ##############
+    # radiometric terrain correction and back-geocoding ##################
     ######################################################################
-    log.info('radiometric terrain correction and backward geocoding')
+    log.info('radiometric terrain correction and back-geocoding')
     for image in images:
         if 'lat' in locals():
             lat.product(data_1=image,
@@ -1242,14 +1242,17 @@ def S1_deburst(burst1, burst2, burst3, name_out, rlks=5, azlks=1,
                            outdir=outdir,
                            shellscript=shellscript)
 
-    isp.SLC_mosaic_S1_TOPS(SLC_tab=tab_out,
-                           SLC=name_out,
-                           SLC_par=name_out + '.par',
-                           rlks=rlks,
-                           azlks=azlks,
-                           logpath=logpath,
-                           outdir=outdir,
-                           shellscript=shellscript)
+    new = 'SLC_mosaic_ScanSAR'
+    old = 'SLC_mosaic_S1_TOPS'
+    slc_mosaic = new if hasattr(isp, new) else old
+    getattr(isp, slc_mosaic)(SLC_tab=tab_out,
+                             SLC=name_out,
+                             SLC_par=name_out + '.par',
+                             rlks=rlks,
+                             azlks=azlks,
+                             logpath=logpath,
+                             outdir=outdir,
+                             shellscript=shellscript)
     if replace:
         for item in [burst1, burst2, burst3]:
             for subitem in [item + x for x in ['', '.par', '.tops_par']]:
@@ -1314,7 +1317,7 @@ def pixel_area_wrap(image, namespace, lut, exist_ok=False,
                        'outdir': outdir,
                        'shellscript': shellscript}
 
-    # newer versions of GAMMA enable creating the ratio of ellipsoid based
+    # newer versions of GAMMA enable creating the ratio of ellipsoid-based
     # pixel area and DEM-facet pixel area directly with command pixel_area
     if hasarg(diff.pixel_area, 'sig2gam_ratio'):
         namespace.appreciate(['pix_ratio'])
@@ -1351,7 +1354,7 @@ def pixel_area_wrap(image, namespace, lut, exist_ok=False,
                     if c1 or c2:
                         shutil.copy(src=image + '.hdr', dst=hdr_out)
 
-        # ratio of ellipsoid based pixel area and DEM-facet pixel area
+        # ratio of ellipsoid-based pixel area and DEM-facet pixel area
         c1 = not os.path.isfile(namespace.pix_ratio)
         c2 = os.path.isfile(namespace.pix_ratio) and not exist_ok
         if c1 or c2:
@@ -1366,6 +1369,8 @@ def pixel_area_wrap(image, namespace, lut, exist_ok=False,
                           outdir=outdir,
                           shellscript=shellscript)
             else:
+                for item in ['pix_area_gamma0', 'pix_ellip_sigma0']:
+                    par2hdr(image + '.par', namespace[item] + '.hdr')
                 lat_ratio(data_in1=namespace.pix_ellip_sigma0,
                           data_in2=namespace.pix_area_gamma0,
                           data_out=namespace.pix_ratio)
@@ -1385,6 +1390,8 @@ def pixel_area_wrap(image, namespace, lut, exist_ok=False,
                           outdir=outdir,
                           shellscript=shellscript)
             else:
+                for item in ['pix_area_gamma0', 'pix_area_sigma0']:
+                    par2hdr(image + '.par', namespace[item] + '.hdr')
                 lat_ratio(data_in1=namespace.pix_area_gamma0,
                           data_in2=namespace.pix_area_sigma0,
                           data_out=namespace.gs_ratio)
@@ -1395,7 +1402,8 @@ def pixel_area_wrap(image, namespace, lut, exist_ok=False,
             hdr_out = namespace[item] + '.hdr'
             c1 = not os.path.isfile(item)
             c2 = os.path.isfile(hdr_out) and not exist_ok
-            par2hdr(image + '.par', hdr_out)
+            if c1 or c2:
+                par2hdr(image + '.par', hdr_out)
 
 
 def gc_map_wrap(image, namespace, dem, spacing, exist_ok=False,