Read metadata from NISAR L2 products (#781)

* add Grid class at the C++ level

* add Python binding of the Grid class

* update C++ Product class with the new Grid class

* update Python Product class with the new Grid class

* add serialization of the Grid class from the HDF5 file

* update product forward.h with the Grid class

* add classes Grid and Product to the Python product namespace

* generalize Base class to other products than SLC

* add new Python (Pybind11) Grid and ProductClass classes to Sources.cmake

* add ProductFactory() class

* make method setProductType() private

* set productType as RSLC regardless of the HDF5 group RSLC/SLC

* update value assignment of productType in Base and SLC classes

* simplify _setProduct method of SLC class after changes in ProductFactory

* make Base.py general for LSAR and SSAR frequency bands

* avoid memory allocation and string copying

* add comments to Product.cpp and limit the maximum number of grids/swaths and identification groups to 1

* add function to find unique group paths (excluding repeated occurrences)

* add unitest to ProductFactory class

* add getProductTypeFromHdf5File to ProductFactory.py

* fix ProductFactory for GSLC products (2)

* fix extractWithIterator for val undefined if KeyError exception is raised

* fix broken ProductFactory.py after updates

* create open_nisar_product and move ProductFactory to GenericProduct

* rename open_nisar_product() to open_product()

* substitute backslashes with parenthesis for line continuation

* substitute get_product_type_from_hdf5File() with get_product_type_from_hdf5_file()

* improve docstrings and function/variable names

* if logger is declared (not None) use logger to raise an exception in h5prep

* send exceptions to pyre journal rather than raising default python exceptions

* declare pyre error channel locally

* fix typos

* rename python/packages/pybind_nisar to python/packages/nisar

* rename pybind_nisar to nisar (2)

* rename pybind_nisar to nisar (3)

* remove commented code

* fix comment in serialization of Grid metadata

* handle the potential case where "frequencyA" does not exist in serialization of Grid metadata

* remove unnecessary includes

* add docstrings to Grid class

* remove commented code

* add units to Grid class attributes

* comment serialization of zeroDopplerTimeSpacing in Grid metadata

* check if frequencyA exists before serializing swath for that frequency

* separate L2 products class (new L2Product class) from c++ Product class

* add unitest to pybind11 class: Grid

* copy zero Doppler time spacing from RSLC to GCOV/GSLC products

* update golden dataset and Grid unitest for updated zeroDopplerTimeSpacing fields

* add comments to explain map association for C++ Product and L2Product classes

* Update cxx/isce3/product/L2Product.h

Co-authored-by: Geoffrey M Gunter <[email protected]>

* Update cxx/isce3/product/Product.h

Co-authored-by: Geoffrey M Gunter <[email protected]>

* pass std::string and std::vector by reference rather than by value

* remove unused includes

* add description to new GCOV sample product nisar_129_gcov_crop.h5

* update docstring of function findGroupPath()

* update docstring of function setImageMetadataGroupStr()

* rename Product to RadarGridProduct and L2Product to GeoGridProduct

* remove blank line

* remove cxx/isce3/geocode/interpolate.h

Co-authored-by: Gustavo H Shiroma <[email protected]>
Co-authored-by: Liang Yu <[email protected]>
Co-authored-by: Geoffrey M Gunter <[email protected]>

Author: 4 people

cxx/isce3/Headers.cmake

@@ -139,7 +139,8 @@ product/forward.h
 product/GeoGridParameters.h
 product/Metadata.h
 product/ProcessingInformation.h
-product/Product.h
+product/RadarGridProduct.h
+product/GeoGridProduct.h
 product/RadarGridParameters.h
 product/Serialization.h
 product/Swath.h

cxx/isce3/Sources.cmake

@@ -67,9 +67,10 @@ math/polyfunc.cpp
 math/RootFind1dNewton.cpp
 math/RootFind1dSecant.cpp
 polsar/symmetrize.cpp
-product/GeoGridParameters.cpp
-product/Product.cpp
 product/RadarGridParameters.cpp
+product/GeoGridParameters.cpp
+product/RadarGridProduct.cpp
+product/GeoGridProduct.cpp
 signal/Covariance.cpp
 signal/Crossmul.cpp
 signal/CrossMultiply.cpp

cxx/isce3/cuda/geometry/Geo2rdr.h

@@ -17,8 +17,8 @@
 class isce3::cuda::geometry::Geo2rdr : public isce3::geometry::Geo2rdr {
 
     public:
-        /** Constructor from Product */
-        inline Geo2rdr(const isce3::product::Product & product,
+        /** Constructor from RadarGridProduct */
+        inline Geo2rdr(const isce3::product::RadarGridProduct & product,
                        char frequency = 'A',
                        bool nativeDoppler = false) :
             isce3::geometry::Geo2rdr(product, frequency, nativeDoppler) {}

cxx/isce3/cuda/geometry/Topo.h

@@ -17,8 +17,8 @@
 class isce3::cuda::geometry::Topo : public isce3::geometry::Topo {
 
     public:
-        /** Constructor from Product */
-        inline Topo(const isce3::product::Product & product,
+        /** Constructor from RadarGridProduct */
+        inline Topo(const isce3::product::RadarGridProduct & product,
                     char frequency = 'A',
                     bool nativeDoppler = false) :
             isce3::geometry::Topo(product, frequency, nativeDoppler){}

cxx/isce3/cuda/geometry/gpuRTC.cu

@@ -20,7 +20,7 @@
 #include <isce3/geometry/DEMInterpolator.h>
 #include <isce3/geometry/RTC.h>
 #include <isce3/geometry/Topo.h>
-#include <isce3/product/Product.h>
+#include <isce3/product/RadarGridProduct.h>
 
 #include <isce3/cuda/core/gpuLUT1d.h>
 #include <isce3/cuda/core/Orbit.h>
@@ -271,7 +271,7 @@ namespace isce3 { namespace cuda {
 
     namespace geometry {
 
-void computeRtc(isce3::product::Product& product, isce3::io::Raster& dem,
+void computeRtc(isce3::product::RadarGridProduct& product, isce3::io::Raster& dem,
                 isce3::io::Raster& out_raster, char frequency)
 {
 

cxx/isce3/cuda/geometry/gpuRTC.h

@@ -4,6 +4,6 @@
 #include <isce3/product/forward.h>
 
 namespace isce3 { namespace cuda { namespace geometry {
-void computeRtc(isce3::product::Product& product, isce3::io::Raster& dem,
+void computeRtc(isce3::product::RadarGridProduct& product, isce3::io::Raster& dem,
                 isce3::io::Raster& out_raster, char frequency = 'A');
 }}}

cxx/isce3/cuda/image/ResampSlc.h

@@ -10,13 +10,13 @@ class isce3::cuda::image::ResampSlc : public isce3::image::ResampSlc {
 
     public:
         // Meta-methods
-        // Constructor from an isce3::product::Product
-        inline ResampSlc(const isce3::product::Product &product, char frequency = 'A') :
+        // Constructor from an isce3::product::RadarGridProduct
+        inline ResampSlc(const isce3::product::RadarGridProduct &product, char frequency = 'A') :
             isce3::image::ResampSlc(product, frequency) {}
 
-        // Constructor from an isce3::product::Product and reference product (flattening)
-        inline ResampSlc(const isce3::product::Product & product,
-                         const isce3::product::Product & refProduct,
+        // Constructor from an isce3::product::RadarGridProduct and reference product (flattening)
+        inline ResampSlc(const isce3::product::RadarGridProduct & product,
+                         const isce3::product::RadarGridProduct & refProduct,
                          char frequency = 'A') :
             isce3::image::ResampSlc(product, refProduct, frequency) {}
 

cxx/isce3/geocode/GeocodeCov.h

@@ -15,7 +15,7 @@
 #include <isce3/io/Raster.h>
 
 // isce3::product
-#include <isce3/product/Product.h>
+#include <isce3/product/RadarGridProduct.h>
 #include <isce3/product/RadarGridParameters.h>
 
 // isce3::geometry

cxx/isce3/geocode/geocodeSlc.cpp

@@ -14,7 +14,7 @@
 #include <isce3/geometry/geometry.h>
 #include <isce3/io/Raster.h>
 #include <isce3/product/GeoGridParameters.h>
-#include <isce3/product/Product.h>
+#include <isce3/product/RadarGridProduct.h>
 #include <isce3/product/RadarGridParameters.h>
 
 

cxx/isce3/geometry/Geo2rdr.h

@@ -22,7 +22,7 @@
 #include <isce3/io/Raster.h>
 
 // isce3::product
-#include <isce3/product/Product.h>
+#include <isce3/product/RadarGridProduct.h>
 #include <isce3/product/RadarGridParameters.h>
 
 #include <limits>
@@ -50,7 +50,7 @@ class isce3::geometry::Geo2rdr {
      * @param[in] frequency Frequency designation
      * @param[in] nativeDoppler Flag for using native Doppler frequencies instead of zero-Doppler
      */
-    Geo2rdr(const isce3::product::Product &,
+    Geo2rdr(const isce3::product::RadarGridProduct &,
             char frequency = 'A',
             bool nativeDoppler = false);