ENH: Use the window argument to subset SAR data during SNAP pre-pro…

…cess #186
sertit · Feb 21, 2025 · b4417ba · b4417ba
1 parent 7e5a107
commit b4417ba
Show file tree

Hide file tree

Showing 13 changed files with 227 additions and 63 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -23,6 +23,7 @@
 - **ENH: Adding the support of WorldView Legion constellation** ([#183](https://github.com/sertit/eoreader/issues/183))
 - **ENH: Adding the support of Umbra constellation (only GEC file)** ([#114](https://github.com/sertit/eoreader/issues/114))
 - **ENH: Add the ability to open a product with a context manager** ([#133](https://github.com/sertit/eoreader/issues/133))
+- **ENH: Use the `window` argument to subset SAR data during SNAP pre-process** ([#186](https://github.com/sertit/eoreader/issues/186))
 - **ENH: Add a function computing the centroid of the footprint of the product**
 - **ENH: Add a `path` attribute to the bands, corresponding to their path on disk**
 - FIX: Fix toa radiance to toa reflectance computation for VHR data

diff --git a/ci/weekly/test_all_sat_end_to_end_on_disk.py b/ci/weekly/test_all_sat_end_to_end_on_disk.py
@@ -200,7 +200,9 @@ def _test_core(
 
             with tempfile.TemporaryDirectory() as tmp_dir:
                 if WRITE_ON_DISK:
-                    tmp_dir = os.path.join("/home/data/ci/e2e_satellites")
+                    tmp_dir = os.path.join(
+                        "/mnt", "ds2_db3", "CI", "eoreader", "e2e_satellites"
+                    )
                 output = tmp_dir
                 is_zip = "_ZIP" if prod.is_archived else ""
                 prod.output = os.path.join(output, f"{prod.condensed_name}{is_zip}")

diff --git a/eoreader/data/cplx_no_calib_preprocess_default.xml b/eoreader/data/cplx_no_calib_preprocess_default.xml
@@ -7,11 +7,27 @@
       <file>${file}</file>
     </parameters>
   </node>
-
+<node id="Subset">
+    <operator>Subset</operator>
+    <sources>
+      <sourceProduct refid="Read"/>
+    </sources>
+    <parameters class="com.bc.ceres.binding.dom.XppDomElement">
+      <sourceBands/>
+      <tiePointGrids/>
+      <region/>
+      <referenceBand/>
+      <geoRegion>${aoi}</geoRegion>
+      <subSamplingX>1</subSamplingX>
+      <subSamplingY>1</subSamplingY>
+      <fullSwath>false</fullSwath>
+      <copyMetadata>false</copyMetadata>
+    </parameters>
+  </node>
   <node id="Multilook">
     <operator>Multilook</operator>
     <sources>
-      <sourceProduct refid="Read"/>
+      <sourceProduct refid="Subset"/>
     </sources>
     <parameters class="com.bc.ceres.binding.dom.XppDomElement">
       <sourceBands/>

diff --git a/eoreader/data/cplx_s1_preprocess_default.xml b/eoreader/data/cplx_s1_preprocess_default.xml
@@ -8,11 +8,28 @@
       <formatName>SENTINEL-1</formatName>
     </parameters>
   </node>
+<node id="Subset">
+    <operator>Subset</operator>
+    <sources>
+      <sourceProduct refid="Read"/>
+    </sources>
+    <parameters class="com.bc.ceres.binding.dom.XppDomElement">
+      <sourceBands/>
+      <tiePointGrids/>
+      <region/>
+      <referenceBand/>
+      <geoRegion>${aoi}</geoRegion>
+      <subSamplingX>1</subSamplingX>
+      <subSamplingY>1</subSamplingY>
+      <fullSwath>false</fullSwath>
+      <copyMetadata>false</copyMetadata>
+    </parameters>
+  </node>
 
   <node id="ThermalNoiseRemoval">
     <operator>ThermalNoiseRemoval</operator>
     <sources>
-      <sourceProduct refid="Read"/>
+      <sourceProduct refid="Subset"/>
     </sources>
     <parameters class="com.bc.ceres.binding.dom.XppDomElement">
       <selectedPolarisations/>

diff --git a/eoreader/data/cplx_s1_sm_preprocess_default.xml b/eoreader/data/cplx_s1_sm_preprocess_default.xml
@@ -8,11 +8,28 @@
       <formatName>SENTINEL-1</formatName>
     </parameters>
   </node>
+<node id="Subset">
+    <operator>Subset</operator>
+    <sources>
+      <sourceProduct refid="Read"/>
+    </sources>
+    <parameters class="com.bc.ceres.binding.dom.XppDomElement">
+      <sourceBands/>
+      <tiePointGrids/>
+      <region/>
+      <referenceBand/>
+      <geoRegion>${aoi}</geoRegion>
+      <subSamplingX>1</subSamplingX>
+      <subSamplingY>1</subSamplingY>
+      <fullSwath>false</fullSwath>
+      <copyMetadata>false</copyMetadata>
+    </parameters>
+  </node>
 
   <node id="ThermalNoiseRemoval">
     <operator>ThermalNoiseRemoval</operator>
     <sources>
-      <sourceProduct refid="Read"/>
+      <sourceProduct refid="Subset"/>
     </sources>
     <parameters class="com.bc.ceres.binding.dom.XppDomElement">
       <selectedPolarisations/>

diff --git a/eoreader/data/cplx_sar_preprocess_default.xml b/eoreader/data/cplx_sar_preprocess_default.xml
@@ -7,10 +7,27 @@
       <file>${file}</file>
     </parameters>
   </node>
+<node id="Subset">
+    <operator>Subset</operator>
+    <sources>
+      <sourceProduct refid="Read"/>
+    </sources>
+    <parameters class="com.bc.ceres.binding.dom.XppDomElement">
+      <sourceBands/>
+      <tiePointGrids/>
+      <region/>
+      <referenceBand/>
+      <geoRegion>${aoi}</geoRegion>
+      <subSamplingX>1</subSamplingX>
+      <subSamplingY>1</subSamplingY>
+      <fullSwath>false</fullSwath>
+      <copyMetadata>false</copyMetadata>
+    </parameters>
+  </node>
   <node id="Calibration">
     <operator>Calibration</operator>
     <sources>
-      <sourceProduct refid="Read"/>
+      <sourceProduct refid="Subset"/>
     </sources>
     <parameters class="com.bc.ceres.binding.dom.XppDomElement">
       <sourceBands/>

diff --git a/eoreader/data/grd_no_calib_preprocess_default.xml b/eoreader/data/grd_no_calib_preprocess_default.xml
@@ -7,10 +7,27 @@
       <file>${file}</file>
     </parameters>
   </node>
+<node id="Subset">
+    <operator>Subset</operator>
+    <sources>
+      <sourceProduct refid="Read"/>
+    </sources>
+    <parameters class="com.bc.ceres.binding.dom.XppDomElement">
+      <sourceBands/>
+      <tiePointGrids/>
+      <region/>
+      <referenceBand/>
+      <geoRegion>${aoi}</geoRegion>
+      <subSamplingX>1</subSamplingX>
+      <subSamplingY>1</subSamplingY>
+      <fullSwath>false</fullSwath>
+      <copyMetadata>false</copyMetadata>
+    </parameters>
+  </node>
   <node id="Terrain-Correction">
     <operator>Terrain-Correction</operator>
     <sources>
-      <sourceProduct refid="LinearToFromdB"/>
+      <sourceProduct refid="Subset"/>
     </sources>
     <parameters class="com.bc.ceres.binding.dom.XppDomElement">
       <sourceBands/>
@@ -46,7 +63,7 @@
   <node id="LinearToFromdB">
     <operator>LinearToFromdB</operator>
     <sources>
-      <sourceProduct refid="Read"/>
+      <sourceProduct refid="Terrain-Correction"/>
     </sources>
     <parameters class="com.bc.ceres.binding.dom.XppDomElement">
       <sourceBands/>

diff --git a/eoreader/data/grd_s1_preprocess_default.xml b/eoreader/data/grd_s1_preprocess_default.xml
@@ -5,6 +5,24 @@
     <sources/>
     <parameters class="com.bc.ceres.binding.dom.XppDomElement">
       <file>${file}</file>
+      <formatName>SENTINEL-1</formatName>
+    </parameters>
+  </node>
+<node id="Subset">
+    <operator>Subset</operator>
+    <sources>
+      <sourceProduct refid="Subset"/>
+    </sources>
+    <parameters class="com.bc.ceres.binding.dom.XppDomElement">
+      <sourceBands/>
+      <tiePointGrids/>
+      <region/>
+      <referenceBand/>
+      <geoRegion>${aoi}</geoRegion>
+      <subSamplingX>1</subSamplingX>
+      <subSamplingY>1</subSamplingY>
+      <fullSwath>false</fullSwath>
+      <copyMetadata>false</copyMetadata>
     </parameters>
   </node>
   <node id="Apply-Orbit-File">
@@ -62,7 +80,7 @@
   <node id="Terrain-Correction">
     <operator>Terrain-Correction</operator>
     <sources>
-      <sourceProduct refid="LinearToFromdB"/>
+      <sourceProduct refid="Calibration"/>
     </sources>
     <parameters class="com.bc.ceres.binding.dom.XppDomElement">
       <sourceBands/>
@@ -98,7 +116,7 @@
   <node id="LinearToFromdB">
     <operator>LinearToFromdB</operator>
     <sources>
-      <sourceProduct refid="Calibration"/>
+      <sourceProduct refid="Terrain-Correction"/>
     </sources>
     <parameters class="com.bc.ceres.binding.dom.XppDomElement">
       <sourceBands/>

diff --git a/eoreader/data/grd_sar_preprocess_default.xml b/eoreader/data/grd_sar_preprocess_default.xml
@@ -7,10 +7,27 @@
       <file>${file}</file>
     </parameters>
   </node>
+<node id="Subset">
+    <operator>Subset</operator>
+    <sources>
+      <sourceProduct refid="Read"/>
+    </sources>
+    <parameters class="com.bc.ceres.binding.dom.XppDomElement">
+      <sourceBands/>
+      <tiePointGrids/>
+      <region/>
+      <referenceBand/>
+      <geoRegion>${aoi}</geoRegion>
+      <subSamplingX>1</subSamplingX>
+      <subSamplingY>1</subSamplingY>
+      <fullSwath>false</fullSwath>
+      <copyMetadata>false</copyMetadata>
+    </parameters>
+  </node>
   <node id="Calibration">
     <operator>Calibration</operator>
     <sources>
-      <sourceProduct refid="Read"/>
+      <sourceProduct refid="Subset"/>
     </sources>
     <parameters class="com.bc.ceres.binding.dom.XppDomElement">
       <sourceBands/>
@@ -29,7 +46,7 @@
   <node id="Terrain-Correction">
     <operator>Terrain-Correction</operator>
     <sources>
-      <sourceProduct refid="LinearToFromdB"/>
+      <sourceProduct refid="Calibration"/>
     </sources>
     <parameters class="com.bc.ceres.binding.dom.XppDomElement">
       <sourceBands/>
@@ -65,7 +82,7 @@
   <node id="LinearToFromdB">
     <operator>LinearToFromdB</operator>
     <sources>
-      <sourceProduct refid="Calibration"/>
+      <sourceProduct refid="Terrain-Correction"/>
     </sources>
     <parameters class="com.bc.ceres.binding.dom.XppDomElement">
       <sourceBands/>

diff --git a/eoreader/data/grd_sar_preprocess_fallback.xml b/eoreader/data/grd_sar_preprocess_fallback.xml
@@ -7,10 +7,27 @@
       <file>${file}</file>
     </parameters>
   </node>
+<node id="Subset">
+    <operator>Subset</operator>
+    <sources>
+      <sourceProduct refid="Read"/>
+    </sources>
+    <parameters class="com.bc.ceres.binding.dom.XppDomElement">
+      <sourceBands/>
+      <tiePointGrids/>
+      <region/>
+      <referenceBand/>
+      <geoRegion>${aoi}</geoRegion>
+      <subSamplingX>1</subSamplingX>
+      <subSamplingY>1</subSamplingY>
+      <fullSwath>false</fullSwath>
+      <copyMetadata>false</copyMetadata>
+    </parameters>
+  </node>
   <node id="Terrain-Correction">
     <operator>Terrain-Correction</operator>
     <sources>
-      <sourceProduct refid="Read"/>
+      <sourceProduct refid="Subset"/>
     </sources>
     <parameters class="com.bc.ceres.binding.dom.XppDomElement">
       <sourceBands/>

diff --git a/eoreader/products/optical/optical_product.py b/eoreader/products/optical/optical_product.py
@@ -27,7 +27,7 @@
 import xarray as xr
 from rasterio import crs as riocrs
 from rasterio.enums import Resampling
-from sertit import AnyPath, files, path, rasters
+from sertit import AnyPath, path, rasters
 from sertit.misc import ListEnum
 from sertit.types import AnyPathStrType, AnyPathType
 
@@ -678,17 +678,8 @@ def _get_clean_band_path(
         rad_proc = "" if kwargs.get(TO_REFLECTANCE, True) else "_as_is"
 
         # Window name
-        window = kwargs.get("window")
-
-        win_suffix = ""
-        if window is not None:
-            if path.is_path(window):
-                win_suffix = path.get_filename(window)
-            elif isinstance(window, gpd.GeoDataFrame):
-                win_suffix = window.attrs.get("name")
-            if not win_suffix:
-                win_suffix = f"win{files.hash_file_content(str(window))}"
-
+        win_suffix = utils.get_window_suffix(kwargs.get("window"))
+        if win_suffix:
             win_suffix += "_"
 
         return self._get_band_folder(writable).joinpath(