DOC: Add warnings for shifts when orthorectifying DIMAP SEN products …

…(using RPCs) sertit#53
bastiencyr · Sep 13, 2022 · af3da09 · af3da09
1 parent a6b4abf
commit af3da09
Show file tree

Hide file tree

Showing 3 changed files with 106 additions and 29 deletions.
diff --git a/CHANGES.md b/CHANGES.md
@@ -32,6 +32,7 @@
 
 - DOC: Add the need of using SNAP 8.0 up-to-date or SNAP 9.0 ([#42](https://github.com/sertit/eoreader/issues/42))
 - DOC: Add the STAC session in API documentation
+- DOC: Add warnings for shifts when orthorectifying DIMAP SEN products (using RPCs) ([#53](https://github.com/sertit/eoreader/issues/53))
 - DEPS: Dropping support of Python 3.7 ([#18](https://github.com/sertit/eoreader/issues/18))
 - DEPS: Update minimum version of libs *(geopadans 0.11.0+, rasterio 1.3.0+...)*
 

diff --git a/docs/notebooks/VHR.ipynb b/docs/notebooks/VHR.ipynb
@@ -3,7 +3,11 @@
   {
    "cell_type": "markdown",
    "id": "1a8ab2e1",
-   "metadata": {},
+   "metadata": {
+    "pycharm": {
+     "name": "#%% md\n"
+    }
+   },
    "source": [
     "# VHR example\n",
     "Let's use EOReader with Very High Resolution data.\n",
@@ -15,7 +19,11 @@
    "cell_type": "code",
    "execution_count": 1,
    "id": "fb4d6b22",
-   "metadata": {},
+   "metadata": {
+    "pycharm": {
+     "name": "#%%\n"
+    }
+   },
    "outputs": [],
    "source": [
     "import os\n",
@@ -30,7 +38,11 @@
   {
    "cell_type": "markdown",
    "id": "b9d68f77",
-   "metadata": {},
+   "metadata": {
+    "pycharm": {
+     "name": "#%% md\n"
+    }
+   },
    "source": [
     "## Create the logger"
    ]
@@ -39,7 +51,11 @@
    "cell_type": "code",
    "execution_count": 2,
    "id": "2dba81a7",
-   "metadata": {},
+   "metadata": {
+    "pycharm": {
+     "name": "#%%\n"
+    }
+   },
    "outputs": [],
    "source": [
     "# Create logger\n",
@@ -64,7 +80,11 @@
   {
    "cell_type": "markdown",
    "id": "dea17812",
-   "metadata": {},
+   "metadata": {
+    "pycharm": {
+     "name": "#%% md\n"
+    }
+   },
    "source": [
     "# Open the VHR product\n",
     "\n",
@@ -76,7 +96,11 @@
    "cell_type": "code",
    "execution_count": 3,
    "id": "62e00730",
-   "metadata": {},
+   "metadata": {
+    "pycharm": {
+     "name": "#%%\n"
+    }
+   },
    "outputs": [],
    "source": [
     "# Set a DEM\n",
@@ -127,7 +151,10 @@
    "execution_count": 4,
    "id": "c568a5f9",
    "metadata": {
-    "scrolled": false
+    "scrolled": false,
+    "pycharm": {
+     "name": "#%%\n"
+    }
    },
    "outputs": [
     {
@@ -149,7 +176,10 @@
    "execution_count": 6,
    "id": "481d7bed",
    "metadata": {
-    "scrolled": true
+    "scrolled": true,
+    "pycharm": {
+     "name": "#%%\n"
+    }
    },
    "outputs": [
     {
@@ -187,25 +217,39 @@
   {
    "cell_type": "markdown",
    "id": "9b5add7d",
-   "metadata": {},
+   "metadata": {
+    "pycharm": {
+     "name": "#%% md\n"
+    }
+   },
    "source": [
     "Here, if you want to orthorectify or pansharpen your data manually, you can set your stack here.\n",
     "\n",
-    "If you do not provide this stack, but you give a non-orthorectified product to EOReader\n",
-    "(i.e. `SEN` or `PRJ` products for Pleiades), you must provide a DEM to orthorectify correctly the data.\n",
-    "\n",
     "```python\n",
     "prod.ortho_stack = \"/path/to/ortho_stack.tif\"\n",
     "```\n",
     "\n",
+    "If you do not provide this stack, but you give a non-orthorectified product to EOReader\n",
+    "(i.e. `SEN` or `PRJ` products for Pleiades), you must provide a DEM to orthorectify correctly the data.\n",
+    "\n",
+    "⚠⚠⚠\n",
+    "DIMAP SEN products are orthorectified using RPCs and not the rigorous sensor model.\n",
+    "A shift of several meters can occur.\n",
+    "Please refer to [this issue](https://github.com/sertit/eoreader/issues/53).\n",
+    "\n",
+    "\n",
     "## Load some bands"
    ]
   },
   {
    "cell_type": "code",
    "execution_count": 8,
    "id": "a122e342",
-   "metadata": {},
+   "metadata": {
+    "pycharm": {
+     "name": "#%%\n"
+    }
+   },
    "outputs": [
     {
      "name": "stdout",
@@ -229,7 +273,10 @@
    "execution_count": 9,
    "id": "62873f96",
    "metadata": {
-    "scrolled": true
+    "scrolled": true,
+    "pycharm": {
+     "name": "#%%\n"
+    }
    },
    "outputs": [
     {
@@ -672,7 +719,11 @@
    "cell_type": "code",
    "execution_count": 10,
    "id": "1f27e722",
-   "metadata": {},
+   "metadata": {
+    "pycharm": {
+     "name": "#%%\n"
+    }
+   },
    "outputs": [
     {
      "data": {
@@ -707,7 +758,11 @@
    "cell_type": "code",
    "execution_count": 11,
    "id": "b89c261f",
-   "metadata": {},
+   "metadata": {
+    "pycharm": {
+     "name": "#%%\n"
+    }
+   },
    "outputs": [
     {
      "data": {
@@ -741,7 +796,11 @@
    "cell_type": "code",
    "execution_count": 12,
    "id": "9ab63653",
-   "metadata": {},
+   "metadata": {
+    "pycharm": {
+     "name": "#%%\n"
+    }
+   },
    "outputs": [
     {
      "data": {
@@ -776,7 +835,10 @@
    "execution_count": 13,
    "id": "2823e27a",
    "metadata": {
-    "scrolled": true
+    "scrolled": true,
+    "pycharm": {
+     "name": "#%%\n"
+    }
    },
    "outputs": [
     {
@@ -810,7 +872,11 @@
   {
    "cell_type": "markdown",
    "id": "0a6cc755",
-   "metadata": {},
+   "metadata": {
+    "pycharm": {
+     "name": "#%% md\n"
+    }
+   },
    "source": [
     "## Stack some bands"
    ]
@@ -819,7 +885,11 @@
    "cell_type": "code",
    "execution_count": 14,
    "id": "331e9088",
-   "metadata": {},
+   "metadata": {
+    "pycharm": {
+     "name": "#%%\n"
+    }
+   },
    "outputs": [
     {
      "data": {
@@ -1354,7 +1424,11 @@
    "cell_type": "code",
    "execution_count": 15,
    "id": "69813b6d",
-   "metadata": {},
+   "metadata": {
+    "pycharm": {
+     "name": "#%%\n"
+    }
+   },
    "outputs": [
     {
      "data": {

diff --git a/docs/optical.md b/docs/optical.md
@@ -24,19 +24,21 @@ The Data Access Portfolio Document presents the offer of the datasets and data a
 | PlanetScope        | {meth}`~eoreader.products.PlaProduct`                   | L3A & L3B                 | 3m                                   | ✅                 |
 | SkySat             | {meth}`~eoreader.products.SkyProduct`                   | (Collect Product) ortho_* | 0.5m                                 | ✅                 |
 | RapidEye           | {meth}`~eoreader.products.ReProduct`                    | L3A                       | 5m                                   | ✅                 |
-| Pleiades-Neo       | {meth}`~eoreader.products.PneoProduct`                  | SEN, PRJ, ORT & MOS                       | 0.3 (PAN), 1.2m (MS)                 | ✅                 |
-| Pleiades           | {meth}`~eoreader.products.PldProduct`                   | SEN, PRJ, ORT & MOS       | 0.5 (PAN), 2m (MS)                   | ✅                 |
+| Pleiades-Neo       | {meth}`~eoreader.products.PneoProduct`                  | SEN**, PRJ, ORT & MOS     | 0.3 (PAN), 1.2m (MS)                 | ✅                 |
+| Pleiades           | {meth}`~eoreader.products.PldProduct`                   | SEN**, PRJ, ORT & MOS     | 0.5 (PAN), 2m (MS)                   | ✅                 |
 | Vision-1           | {meth}`~eoreader.products.Vis1Product`                  | PRJ & ORTP                | 0.9 (PAN), 3.5m (MS)                 | ✅                 |
-| SPOT 4             | {meth}`~eoreader.products.Spot45Product`                | L1A, M1B, L2A             | 10 (PAN), 20m (MS)                   | ✅                 |
-| SPOT 5             | {meth}`~eoreader.products.Spot45Product`                | L1A, M1B, L2A             | 2.5 (SuperMode), 5.0 (PAN), 10m (MS) | ✅                 |
-| SPOT 7             | {meth}`~eoreader.products.Spot7Product`                 | SEN, PRJ, ORT & MOS       | 1.5 (PAN), 6m (MS)                   | ✅                 |
-| SPOT 6             | {meth}`~eoreader.products.Spot6Product`                 | SEN, PRJ, ORT & MOS       | 1.5 (PAN), 6m (MS)                   | ✅                 |
-| Maxar**            | {meth}`~eoreader.products.MaxarProduct`                 | Standard & Ortho          | 0.5 (PAN), 2m (MS)                   | ✅                 |
+| SPOT 4             | {meth}`~eoreader.products.Spot45Product`                | L1A, L1B, L2A             | 10 (PAN), 20m (MS)                   | ✅                 |
+| SPOT 5             | {meth}`~eoreader.products.Spot45Product`                | L1A, L1B, L2A             | 2.5 (SuperMode), 5.0 (PAN), 10m (MS) | ✅                 |
+| SPOT 7             | {meth}`~eoreader.products.Spot7Product`                 | SEN**, PRJ, ORT & MOS     | 1.5 (PAN), 6m (MS)                   | ✅                 |
+| SPOT 6             | {meth}`~eoreader.products.Spot6Product`                 | SEN**, PRJ, ORT & MOS     | 1.5 (PAN), 6m (MS)                   | ✅                 |
+| Maxar***           | {meth}`~eoreader.products.MaxarProduct`                 | Standard & Ortho          | 0.5 (PAN), 2m (MS)                   | ✅                 |
 | SuperView-1        | {meth}`~eoreader.products.Sv1Product`                   | L1B & L2A                 | 0.5 (PAN), 2m (MS)                   | ✅                 |
 
 \* *Archived Landsat Collection-1 are not managed because of the tar.gz format, which is too slow to process. It is better to work on the extracted product. Landsat-9 Collection-1 products don't exist.*
 
-\*\* *Maxar satellites: Worldview 2, 3, 4 and GeoEye-1 (but WorldView-1, QuickBird should work, however they don't have been tested). The resolution can vary around the one given here.*
+\*\* ⚠ *DIMAP SEN products are orthorectified using RPCs and not the rigorous sensor model. Shift can occur. Please refer to [this issue](https://github.com/sertit/eoreader/issues/53).*
+
+\*\*\* *Maxar satellites: Worldview 2, 3, 4 and GeoEye-1 (but WorldView-1, QuickBird should work, however they don't have been tested). The resolution can vary around the one given here.*
 
 ```{warning}
 Satellites products that cannot be used as archived have to be extracted before use.