Update NISAR InSAR product metadata to latest product specifications (isce-framework#60)

* Change the description of processingType

* lower case Reference Terrain Height description

* lower case Reference Terrain Height description for GUNW

* make quotes and backticks consistent

* Modify description of LOS and along-track unit vectors

* Add 'else' catch-all statement for 'OD' case and log in cases when proc type differs from OD

* Sync logging with GCOV workflow

* Remove unused info channel

---------

Co-authored-by: Virginia Brancato <virginia.brancato@jpl.nasa.com>

Author: interferogal

python/packages/nisar/products/insar/GOFF_writer.py

@@ -69,7 +69,7 @@ def add_parameters_to_procinfo_group(self):
         for rslc_name in ['reference', 'secondary']:
             rslc = self[self.group_paths.ParametersPath][rslc_name]
             rslc['referenceTerrainHeight'].attrs['description'] = \
-                np.bytes_("Reference Terrain Height as a function of"
+                np.bytes_("Reference terrain height as a function of"
                            f" map coordinates for {rslc_name} RSLC")
             rslc['referenceTerrainHeight'].attrs['units'] = \
                 Units.meter
@@ -124,7 +124,7 @@ def add_grids_to_hdf5(self):
                  " where 1 is water and 0 is non-water;"
                  " the second digit represents the subswath number of that pixel in the reference RSLC;"
                  " the least-significant digit represents the subswath number of that pixel in the secondary RSLC."
-                 " A value of '0' in either subswath digit indicates an invalid sample in the corresponding RSLC"),
+                 " A value of 0 in either subswath digit indicates an invalid sample in the corresponding RSLC"),
                 grid_mapping=grids_val,
                 xds=xds,
                 yds=yds,

python/packages/nisar/products/insar/GUNW_writer.py

@@ -186,7 +186,7 @@ def add_parameters_to_procinfo_group(self):
         for rslc_name in ['reference', 'secondary']:
             rslc = self[self.group_paths.ParametersPath][rslc_name]
             rslc['referenceTerrainHeight'].attrs['description'] = \
-                np.bytes_("Reference Terrain Height as a function of"
+                np.bytes_("Reference terrain height as a function of"
                            f" map coordinates for {rslc_name} RSLC")
             rslc['referenceTerrainHeight'].attrs['units'] = \
                 Units.meter
@@ -273,7 +273,7 @@ def add_grids_to_hdf5(self):
                      " where 1 is water and 0 is non-water;"
                      " the second digit represents the subswath number of that pixel in the reference RSLC;"
                      " the least-significant digit represents the subswath number of that pixel in the secondary RSLC."
-                     " A value of '0' in either subswath digit indicates an invalid sample in the corresponding RSLC"),
+                     " A value of 0 in either subswath digit indicates an invalid sample in the corresponding RSLC"),
                     grid_mapping=grids_val,
                     xds=xds,
                     yds=yds,

python/packages/nisar/products/insar/InSAR_L1_writer.py

@@ -502,7 +502,7 @@ def add_pixel_offsets_to_swaths_group(self):
                                                  " subswath number of that pixel in the secondary RSLC,"
                                                  " and the most significant digit represents"
                                                  " the subswath number of that pixel in the reference RSLC."
-                                                 " A value of '0' in either digit indicates an invalid sample"
+                                                 " A value of 0 in either digit indicates an invalid sample"
                                                  " in the corresponding RSLC"),
                                     fill_value=255)
             offset_group['mask'].attrs['long_name'] = np.bytes_("Valid samples subswath mask")

python/packages/nisar/products/insar/InSAR_base_writer.py

@@ -4,6 +4,7 @@
 from typing import Any, Optional, Union
 
 import h5py
+import journal
 import numpy as np
 from isce3.core import crop_external_orbit
 from isce3.core.types import complex32, to_complex32
@@ -384,7 +385,7 @@ def add_RSLC_to_procinfo_params_group(self, rslc_name: str):
 
         reference_terrain_height = "referenceTerrainHeight"
         reference_terrain_height_description = \
-            f"Reference Terrain Height as a function of time for {rslc_name} RSLC"
+            f"Reference terrain height as a function of time for {rslc_name} RSLC"
         if reference_terrain_height in src_param_group:
             src_param_group.copy(reference_terrain_height, dst_param_group)
             dst_param_group[reference_terrain_height].attrs['description'] = \
@@ -914,6 +915,7 @@ def add_identification_to_hdf5(self):
         """
         Add the identification group to the product
         """
+        warning_channel = journal.warning('InSAR_base_writer.add_identification_to_hdf5')
         radar_band_name = self._get_band_name()
         primary_exec_cfg = self.cfg["primary_executable"]
 
@@ -930,10 +932,13 @@ def add_identification_to_hdf5(self):
             processing_type = np.bytes_('Nominal')
         elif processing_type == 'UR':
             processing_type = np.bytes_('Urgent')
-        elif processing_type == 'OD':
-            processing_type = np.bytes_('Custom')
         else:
-            processing_type = np.bytes_('Undefined')
+            processing_type = np.bytes_('Custom')
+            if processing_type != 'OD':
+                warning_channel.log(
+                    'The processing type in the runconfig is set to'
+                    f' "{processing_type}", which is not a valid value'
+                    ' for the output product metadata. Defaulting to "Custom"')
 
         # Adopt same logic as RSLC, GSLC, GCOV
         # If no condition is met, assign string from runconfig
@@ -1162,7 +1167,10 @@ def add_identification_to_hdf5(self):
             DatasetParams(
                 "processingType",
                 processing_type,
-                "Nominal (or) Urgent (or) Custom (or) Undefined",
+                'Processing pipeline used to generate this granule. ' \
+                '"Nominal": standard production system; "Urgent": time-sensitive ' \
+                'processing in response to urgent response events; ' \
+                '"Custom": user-initiated processing outside the nominal production system',
             ),
             DatasetParams(
                 "radarBand", radar_band_name,

python/packages/nisar/workflows/h5_prep.py

@@ -842,25 +842,33 @@ def add_radar_grid_cubes_to_hdf5(hdf5_obj, cube_group_name, geogrid,
         cube_group, 'losUnitVectorX', np.float32, cube_shape,
         zds=zds, yds=yds, xds=xds,
         long_name='LOS unit vector X',
-        descr='East component of unit vector of LOS from target to sensor',
+        descr='East component of the line-of-sight (LOS) unit vector, defined from ' \
+              'the target to the sensor, expressed in the east-north-up (ENU) coordinate ' \
+              'system with its origin at the target location',
         units='1', valid_min=-1.0, valid_max=1.0, **create_dataset_kwargs)
     los_unit_vector_y_raster = _get_raster_from_hdf5_ds(
         cube_group, 'losUnitVectorY', np.float32, cube_shape,
         zds=zds, yds=yds, xds=xds,
         long_name='LOS unit vector Y',
-        descr='North component of unit vector of LOS from target to sensor',
+        descr='North component of the line-of-sight (LOS) unit vector, defined from ' \
+              'the target to the sensor, expressed in the east-north-up (ENU) coordinate ' \
+              'system with its origin at the target location',
         units='1', valid_min=-1.0, valid_max=1.0, **create_dataset_kwargs)
     along_track_unit_vector_x_raster = _get_raster_from_hdf5_ds(
         cube_group, 'alongTrackUnitVectorX', np.float32, cube_shape,
         zds=zds, yds=yds, xds=xds,
         long_name='Along-track unit vector X',
-        descr='East component of unit vector along ground track',
+        descr='East component of the along-track unit vector at the target location, ' \
+              'expressed in the east-north-up (ENU) coordinate system and projected ' \
+              'onto the horizontal plane (i.e., excluding the up component)',
         units='1', valid_min=-1.0, valid_max=1.0, **create_dataset_kwargs)
     along_track_unit_vector_y_raster = _get_raster_from_hdf5_ds(
         cube_group, 'alongTrackUnitVectorY', np.float32, cube_shape,
         zds=zds, yds=yds, xds=xds,
         long_name='Along-track unit vector Y',
-        descr='North component of unit vector along ground track',
+        descr='North component of the along-track unit vector at the target location, ' \
+              'expressed in the east-north-up (ENU) coordinate system and projected ' \
+              'onto the horizontal plane (i.e., excluding the up component)',
         units='1', valid_min=-1.0, valid_max=1.0, **create_dataset_kwargs)
     elevation_angle_raster = _get_raster_from_hdf5_ds(
         cube_group, 'elevationAngle', np.float32, cube_shape,