Populate GCOV & GSLC Static Layers Data Access (isce-framework#100)

* disable polarimetric symmetrization by default

* revert changes to `symmetrize_cross_pol_channels`

* Update GCOV and GSLC specification XMLs

* Revert changes to the GCOV and GSLC specification XMLs

* populate static layers data access template

* handle an empty static layers data access

* remove unnecessary `default` argument

* set default value to "(NOT SPECIFIED)"

* Move function `get_static_layers_data_access()` outside of the class `BaseL2WriterSingleInput`

* Move function `get_static_layers_data_access()` outside of the class `BaseL2WriterSingleInput` (2)

* returns "(NOT SPECIFIED)" if `static_layers_data_access_runconfig` is `None` or empty string

* improve function ``get_static_layers_data_access()`

* improve error message

* move `staticLayersDataAccess` from `ceosAnalysisReadyData` group to `identification`

* move the runconfig field `static_layers_data_access` to the `primary_executable` group

* move the runconfig field `static_layers_data_access` to the `primary_executable` group (2); improve docstrings

* improve docstrings

* improve docstrings

* improve runconfig comments

* move `get_static_layers_data_access()` into nisar.products.utils

* fix typo

Author: gshiroma

python/packages/nisar/products/__init__.py

@@ -11,3 +11,4 @@
     populate_dataset_attrs_from_spec,
 )
 from .projection import build_projection_dataset_attrs_dict
+from .utils import get_static_layers_data_access

python/packages/nisar/products/utils.py

@@ -2,6 +2,7 @@
 
 import numpy as np
 from numpy.typing import ArrayLike
+import journal
 
 
 def to_bytes(s: str | ArrayLike) -> np.ndarray:
@@ -16,4 +17,60 @@ def to_bytes(s: str | ArrayLike) -> np.ndarray:
     numpy.ndarray
         The input string(s) converted to bytestrings with 'utf-8' encoding.
     """
-    return np.char.encode(s, encoding="utf-8")
+    return np.char.encode(s, encoding="utf-8")
+
+
+def get_static_layers_data_access(
+        static_layers_data_access_template: str | None,
+        granule_id: str | None) -> str:
+    """
+    Read the static layers data access template and replace the placeholder
+     "{granule_id}" with the granule ID, if provided.
+
+    Parameters
+    ----------
+    static_layers_data_access_template: str or None
+        Template string for static layers data access. If the string contains
+        the substring "{granule_id}", that substring will be replaced with
+        the contents of `granule_id`.
+        If set to `None` or an empty string, the function returns
+        "(NOT SPECIFIED)"
+        If the string is valid, i.e., it is not `None` or an empty string,
+        and it does not contain the substring "{granule_id}", then
+        `granule_id` is ignored.
+    granule_id: str or None
+        The granule ID, which will be used to replace the substring
+        "{granule_id}" in `static_layers_data_access_template`.
+        If the template string contains "{granule_id}", but `granule_id` is
+        `None`, empty string, or "(NOT SPECIFIED)", the function raises an
+        error.
+
+    Returns
+    -------
+    static_layers_data_access: str
+        The static layers data access string with "{granule_id}" placeholder
+        replaced. Returns "(NOT SPECIFIED)" if
+        `static_layers_data_access_template` is `None` or an empty
+        string.
+    """
+
+    if not static_layers_data_access_template:
+        return '(NOT SPECIFIED)'
+
+    static_layers_data_access = static_layers_data_access_template
+
+    if '{granule_id}' in static_layers_data_access_template:
+        if not granule_id or granule_id == '(NOT SPECIFIED)':
+            error_msg = ('The placeholder "{granule_id}" is included in'
+                         ' the static layers data access template,'
+                         ' but the `granule_id` was not provided'
+                         " or is invalid")
+            error_channel = journal.error('get_static_layers_data_access')
+            error_channel.log(error_msg)
+            raise ValueError(error_msg)
+
+        static_layers_data_access = \
+            static_layers_data_access_template.replace('{granule_id}',
+                                                       granule_id)
+
+    return static_layers_data_access

python/packages/nisar/products/writers/BaseL2WriterSingleInput.py

@@ -11,6 +11,7 @@
 from isce3.core.types import truncate_mantissa
 from isce3.geometry import get_near_and_far_range_incidence_angles
 from nisar.products.readers.orbit import load_orbit
+from nisar.products.utils import get_static_layers_data_access
 
 
 LEXICOGRAPHIC_BASE_POLS = ['HH', 'HV', 'VH', 'VV']
@@ -808,12 +809,17 @@ def populate_identification_l2_specific(self):
             'identification/platformName',
             default='(NOT SPECIFIED)')
 
-    def populate_ceos_analysis_ready_data_parameters_l2_common(self):
+        static_layers_data_access_runconfig = \
+            self.cfg['primary_executable']['static_layers_data_access']
 
-        self.copy_from_runconfig(
-            '{PRODUCT}/metadata/ceosAnalysisReadyData/staticLayersDataAccess',
-            'ceos_analysis_ready_data/static_layers_data_access',
-            default='(NOT SPECIFIED)')
+        static_layers_data_access = get_static_layers_data_access(
+            static_layers_data_access_runconfig, self.granule_id)
+
+        self.set_value(
+            'identification/staticLayersDataAccess',
+            static_layers_data_access)
+
+    def populate_ceos_analysis_ready_data_parameters_l2_common(self):
 
         ceos_ard_document_identifier = \
             ('https://ceos.org/ard/files/PFS/SAR/v1.0/CEOS-ARD_PFS'

share/nisar/defaults/gcov.yaml

@@ -134,6 +134,13 @@ runconfig:
             # the corresponding metadata field will be set to "(NOT SPECIFIED)".
             product_doi:
 
+            # Data access for the static layers product associated with the
+            # output product (URL or DOI). If not provided, the corresponding
+            # metadata field will be set to "(NOT SPECIFIED)".
+            # If this string contains the substring "{granule_id}", that substring
+            # will be replaced with the granule ID.
+            static_layers_data_access:
+
             # Composite release ID (CRID). If not provided, the corresponding
             # metadata field will be set to b'A10000'.
             composite_release_id:
@@ -547,10 +554,6 @@ runconfig:
         # to populate the output product's metadata
         ceos_analysis_ready_data:
 
-            # NOT YET IMPLEMENTED
-            # Data access for the static layers product associated with the output product (URL or DOI)
-            static_layers_data_access:
-
             # Estimated geometric accuracy (bias and standard deviation)
             # in meters in the X- and Y-directions over the coordinate
             # system defined by the product's EPSG code

share/nisar/defaults/gslc.yaml

@@ -67,6 +67,14 @@ runconfig:
             product_type: GSLC
             product_version: 0.1.0
             product_doi:
+
+            # Data access for the static layers product associated with the
+            # output product (URL or DOI). If not provided, the corresponding
+            # metadata field will be set to "(NOT SPECIFIED)".
+            # If this string contains the substring "{granule_id}", that substring
+            # will be replaced with the granule ID.
+            static_layers_data_access:
+
             composite_release_id:
             processing_type:
             processing_center:
@@ -327,10 +335,6 @@ runconfig:
         # to populate the output product's metadata
         ceos_analysis_ready_data:
 
-            # NOT YET IMPLEMENTED
-            # Data access for the static layers product associated with the output product (URL or DOI)
-            static_layers_data_access:
-
             # Estimated geometric accuracy (bias and standard deviation)
             # in meters in the X- and Y-directions over the coordinate
             # system defined by the product's EPSG code

share/nisar/schemas/gcov.yaml

@@ -62,6 +62,11 @@ runconfig:
             product_type: enum('GCOV')
             product_version: str('^\d+\.\d+\.\d+$', required=False)
             product_doi: str(required=False)
+
+            # Data access for the static layers product associated with the output
+            # product (URL or DOI)
+            static_layers_data_access: str(required=False)
+
             composite_release_id: regex(r'\w\d\d\d\d\d', name='CRID', required=False)
             processing_type: enum('PR', 'UR', 'OD', required=False)
             product_accuracy: enum('P', 'M', 'N', 'F', required=False)
@@ -537,11 +542,6 @@ geocode_options:
 
 ceos_analysis_ready_data_options:
 
-    # NOT YET IMPLEMENTED
-    # Data access for the static layers product associated with the output
-    # product (URL or DOI)
-    static_layers_data_access: str(required=False)
-
     # Estimated geometric accuracy (bias and standard deviation)
     # in meters in the X- and Y-directions over the coordinate
     # system defined by the product's EPSG code

share/nisar/schemas/gslc.yaml

@@ -63,6 +63,11 @@ runconfig:
             product_type: enum('GSLC')
             product_version: str('^\d+\.\d+\.\d+$', required=False)
             product_doi: str(required=False)
+
+            # Data access for the static layers product associated with the output
+            # product (URL or DOI)
+            static_layers_data_access: str(required=False)
+
             composite_release_id: regex(r'\w\d\d\d\d\d', name='CRID', required=False)
             processing_type: enum('PR', 'UR', 'OD', required=False)
             product_accuracy: enum('P', 'M', 'N', 'F', required=False)
@@ -302,10 +307,6 @@ geocode_options:
 
 ceos_analysis_ready_data_options:
 
-    # NOT YET IMPLEMENTED
-    # Data access for the static layers product associated with the output product (URL or DOI)
-    static_layers_data_access: str(required=False)
-
     # Estimated geometric accuracy (bias and standard deviation)
     # in meters in the X- and Y-directions over the coordinate
     # system defined by the product's EPSG code