InSAR / Water Mask license info metadata not populated #222
Description
Issue
Currently, the operational InSAR products are populating the Water Mask Source with "(NOT SPECIFIED)" and omitting the mask disclaimer. These should be populated with the license terms for the water mask in accordance with its input datasets' licenses.
These errors are noted in the details of Issue #219 and Issue #204 ; submitting this as a separate Issue to raise awareness. Here are the error messages, copied here for convenience (note that the path in these messages has been generalized for all relevant product types):
"Value is '(NOT SPECIFIED)', which is not valid for nominal NISAR data. Path: /science/LSAR/[RIFG|RUNW|GUNW|ROFF|GOFF]/metadata/processingInformation/inputs/waterMaskSource""Attributes found in XML but not HDF5: {'disclaimer', 'valid_min'} - Dataset /science/LSAR/[GUNW | GOFF]/grids/frequencyA/unwrappedInterferogram/mask"
Background
During the implementation of the STATIC layers workflow (which also uses the water mask), there arose several discussions by NISAR ADT regarding the correct process that the STATIC and InSAR SASs should use re: the water mask license. The full discussions and final resolution are documented in these links:
- How to get DEM description + license for Static Layers? How to get DEM description + license for Static Layers? #80
- Add water_mask_file_description to runconfig for InSAR, Static Layers : https://github-fn.jpl.nasa.gov/isce-3/isce/issues/2164
- Add license to staged WaterMask VRT: Add license to staged WaterMask VRT #77
- Add the water mask source and update the L2 InSAR product mask attributes : Add the water mask source and update the L2 InSAR product mask attributes #96
- STATIC workflow implementation: Add Static Layers workflow (MCR #90132) #144
Resolution (copied from: https://github-fn.jpl.nasa.gov/isce-3/isce/issues/2164#issuecomment-24044 ) :
Similar to the decision for the DEM license (see #80 (comment)):
- Static Layers and InSAR products will include a waterMaskSource dataset that includes the concatenated Short Description + Notes fields from teh water mask LICENSE.txt (see here: https://github-fn.jpl.nasa.gov/isce-3/isce/issues/2164#issuecomment-23800)
- Static Layers & GUNW & GOFF product will also include an attribute called disclaimer on their mask layers that includes the same string.
- stage_watermask.py will read these two strings from the LICENSE.txt file, concatenate them into a single string, and insert this string into the water mask VRT file as a metadata item called "water_mask_description". The Static Layers and InSAR workflows will read it directly from the VRT.