csaybar commited on
Commit
5e0f559
·
verified ·
1 Parent(s): e5e34b2

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +24 -16
README.md CHANGED
@@ -34,7 +34,7 @@ size_categories:
34
 
35
  **PyPI**: [https://pypi.org/project/opensr-test/](https://pypi.org/project/opensr-test/)
36
 
37
- **Paper**: [https://www.techrxiv.org/users/760184/articles/735467-a-comprehensive-benchmark-for-optical-remote-sensing-image-super-resolution](https://www.techrxiv.org/users/760184/articles/735467-a-comprehensive-benchmark-for-optical-remote-sensing-image-super-resolution)
38
 
39
  ---
40
 
@@ -42,7 +42,7 @@ size_categories:
42
 
43
  ## **Overview**
44
 
45
- Super-Resolution (SR) aims to improve satellite imagery ground sampling distance. However, two problems are common in the literature. First, most models are **tested on synthetic data**, raising doubts about their real-world applicability and performance. Second, traditional evaluation metrics such as PSNR, LPIPS, and SSIM are not designed to assess SR performance. These metrics fall short, especially in conditions involving changes in luminance or spatial misalignments - scenarios frequently encountered in real world.
46
 
47
  To address these challenges, 'opensr-test' provides a fair approach for SR benchmark. We provide three datasets carefully crafted to minimize spatial and spectral misalignment. Besides, 'opensr-test' precisely assesses SR algorithm performance across three independent metrics groups that measure consistency, synthesis, and correctness.
48
 
@@ -68,6 +68,8 @@ The `opensr-test` package provides five datasets for benchmarking SR models. The
68
  - **`reflectance:`** How SR affects the mean of reflectance values. It uses the L1 norm. The lower the value, the better the reflectance consistency.
69
  - **`spectral:`** This shows how the harmonization affects the spectral signature compared to the LR image. It uses the spectral angle distance. The lower the value, the better the spectral consistency. The values are in degrees.
70
  - **`spatial:`** The spatial misalignment in terms of LR pixels (10m). The lower the value, the better the spatial consistency.
 
 
71
 
72
  | Band | Description | Resolution (m) | L2A Index | L1C index |
73
  |------|-------------|----------------|-------| -------|
@@ -88,7 +90,9 @@ The `opensr-test` package provides five datasets for benchmarking SR models. The
88
 
89
  ### **NAIP (X4 scale factor)**
90
 
91
- The National Agriculture Imagery Program (NAIP) dataset is a high-resolution aerial imagery dataset covering the continental United States. It consists of 2.5m NAIP imagery captured in the visible and near-infrared spectrum (RGBNIR) and all Sentinel-2 L1C and L2A bands. The dataset focuses on crop fields, forests, and bare soil areas.
 
 
92
 
93
  ```python
94
  import opensr_test
@@ -102,7 +106,8 @@ naip = opensr_test.load("naip")
102
 
103
  ### **SPOT (X4 scale factor)**
104
 
105
- The SPOT imagery was obtained from the Worldstat dataset. The dataset consists of 2.5m SPOT imagery captured in the visible and near-infrared spectrum (RGBNIR) and all Sentinel-2 L1C and L2A bands. It focuses on urban areas, crop fields, and bare soil areas.
 
106
 
107
  ```python
108
  import opensr_test
@@ -117,7 +122,9 @@ spot = opensr_test.load("spot")
117
 
118
  ### **Venµs (X2 scale factor)**
119
 
120
- The Venµs images were obtained from the [**Sen2Venµs dataset**](https://zenodo.org/records/6514159). The dataset consists of 5m Venµs imagery captured in the visible and near-infrared spectrum (RGBNIR) and all Sentinel-2 L1C and L2A bands. The dataset focuses on **crop fields, forests, urban areas, and bare soil areas**.
 
 
121
 
122
  ```python
123
  import opensr_test
@@ -131,7 +138,9 @@ venus = opensr_test.load("venus")
131
 
132
  ### **SPAIN CROPS (x4 scale factor)**
133
 
134
- The SPAIN CROPS dataset consists of 2.5m aerial imagery captured in the visible and near-infrared spectrum (RGBNIR) by the Spanish National Geographic Institute (IGN). The dataset includes all Sentinel-2 L1C and L2A bands. The dataset focuses on **crop fields and forests**.
 
 
135
 
136
  ```python
137
  import opensr_test
@@ -145,9 +154,12 @@ spain_crops = opensr_test.load("spain_crops")
145
 
146
  ### **SPAIN URBAN (x4 scale factor)**
147
 
148
- The SPAIN URBAN dataset consists of 2.5m aerial imagery captured in the visible and near-infrared spectrum (RGBNIR) by the Spanish National Geographic Institute (IGN). The dataset includes all Sentinel-2 L1C and L2A bands. The dataset focuses on **urban areas and roads**.
 
 
149
 
150
  ```python
 
151
 
152
  spain_urban = opensr_test.load("spain_urban")
153
  ```
@@ -156,14 +168,6 @@ spain_urban = opensr_test.load("spain_urban")
156
  <a href="https://github.com/ESAOpenSR/opensr-test"><img src="images/SPAIN_URBAN.gif" alt="header" width="80%"></a>
157
  </p>
158
 
159
- ## **Deeper understanding**
160
-
161
- Explore the [API](https://esaopensr.github.io/opensr-test/docs/API/config_pydantic.html) section for more details about personalizing your benchmark experiments.
162
-
163
- <p align="center">
164
- <a href="/docs/api.md"><img src="images/image02.png" alt="opensr-test" width="30%"></a>
165
- </p>
166
-
167
  ## **Citation**
168
 
169
  If you use `opensr-test` in your research, please cite our paper:
@@ -180,4 +184,8 @@ If you use `opensr-test` in your research, please cite our paper:
180
 
181
  ## **Acknowledgements**
182
 
183
- This work was done with the support of the European Space Agency (ESA) under the project “Explainable AI: application to trustworthy super-resolution (OpenSR).” Cesar Aybar acknowledges support by the National Council of Science, Technology, and Technological Innovation (CONCYTEC, Peru) through the “PROYECTOS DE INVESTIGACIÓN BÁSICA – 2023-01” program with contract number PE501083135-2023-PROCIENCIA. Luis Gómez-Chova acknowledges support from the Spanish Ministry of Science and Innovation (project PID2019-109026RB-I00 funded by MCIN/AEI/10.13039/501100011033).
 
 
 
 
 
34
 
35
  **PyPI**: [https://pypi.org/project/opensr-test/](https://pypi.org/project/opensr-test/)
36
 
37
+ **Paper**: [https://ieeexplore.ieee.org/abstract/document/10530998](https://ieeexplore.ieee.org/abstract/document/10530998)
38
 
39
  ---
40
 
 
42
 
43
  ## **Overview**
44
 
45
+ Super-resolution (SR) aims to improve satellite imagery ground sampling distance. However, two problems are common in the literature. First, most models are **tested on synthetic data**, raising doubts about their real-world applicability and performance. Second, traditional evaluation metrics such as PSNR, LPIPS, and SSIM are not designed to assess SR performance. These metrics fall short, especially in conditions involving changes in luminance or spatial misalignments - scenarios frequently encountered in real world.
46
 
47
  To address these challenges, 'opensr-test' provides a fair approach for SR benchmark. We provide three datasets carefully crafted to minimize spatial and spectral misalignment. Besides, 'opensr-test' precisely assesses SR algorithm performance across three independent metrics groups that measure consistency, synthesis, and correctness.
48
 
 
68
  - **`reflectance:`** How SR affects the mean of reflectance values. It uses the L1 norm. The lower the value, the better the reflectance consistency.
69
  - **`spectral:`** This shows how the harmonization affects the spectral signature compared to the LR image. It uses the spectral angle distance. The lower the value, the better the spectral consistency. The values are in degrees.
70
  - **`spatial:`** The spatial misalignment in terms of LR pixels (10m). The lower the value, the better the spatial consistency.
71
+ - **`crs:`** The coordinate reference system of the images.
72
+ - **`affine:`** The affine transformation of the images. It is a 2x3 matrix that maps pixel coordinates to the spatial coordinates.
73
 
74
  | Band | Description | Resolution (m) | L2A Index | L1C index |
75
  |------|-------------|----------------|-------| -------|
 
90
 
91
  ### **NAIP (X4 scale factor)**
92
 
93
+ The National Agriculture Imagery Program (NAIP) dataset is a high-resolution aerial imagery dataset covering the continental United States. **It consists of
94
+ 62 NAIP images at 2.5m** were captured in the visible and near-infrared spectrum (RGBNIR) and all Sentinel-2 L1C and L2A bands. The dataset focuses on crop fields,
95
+ forests, and bare soil areas.
96
 
97
  ```python
98
  import opensr_test
 
106
 
107
  ### **SPOT (X4 scale factor)**
108
 
109
+ The SPOT imagery was obtained from the Worldstat dataset. The dataset consists of **9 SPOT images at 2.5m** captured in the visible and near-infrared
110
+ spectrum (RGBNIR) and all Sentinel-2 L1C and L2A bands. It focuses on urban areas, crop fields, and bare soil areas.
111
 
112
  ```python
113
  import opensr_test
 
122
 
123
  ### **Venµs (X2 scale factor)**
124
 
125
+ The Venµs images were obtained from the [**Sen2Venµs dataset**](https://zenodo.org/records/6514159). The dataset consists of
126
+ **59 Venµs images at 5m** captured in the visible and near-infrared spectrum (RGBNIR) and all Sentinel-2 L1C and L2A bands. The
127
+ dataset focuses on **crop fields, forests, urban areas, and bare soil areas**.
128
 
129
  ```python
130
  import opensr_test
 
138
 
139
  ### **SPAIN CROPS (x4 scale factor)**
140
 
141
+ The SPAIN CROPS dataset consists of **28 aerial images at 2.5m** captured in the visible and near-infrared spectrum (RGBNIR) by
142
+ the Spanish National Geographic Institute (IGN). The dataset includes all Sentinel-2 L1C and L2A bands. The dataset focuses
143
+ on **crop fields and forests**.
144
 
145
  ```python
146
  import opensr_test
 
154
 
155
  ### **SPAIN URBAN (x4 scale factor)**
156
 
157
+ The SPAIN URBAN dataset consists of **20 aerial imagery at 2.5m** captured in the visible and near-infrared spectrum (RGBNIR)
158
+ by the Spanish National Geographic Institute (IGN). The dataset includes all Sentinel-2 L1C and L2A bands. The dataset focuses
159
+ on **urban areas and roads**.
160
 
161
  ```python
162
+ import opensr_test
163
 
164
  spain_urban = opensr_test.load("spain_urban")
165
  ```
 
168
  <a href="https://github.com/ESAOpenSR/opensr-test"><img src="images/SPAIN_URBAN.gif" alt="header" width="80%"></a>
169
  </p>
170
 
 
 
 
 
 
 
 
 
171
  ## **Citation**
172
 
173
  If you use `opensr-test` in your research, please cite our paper:
 
184
 
185
  ## **Acknowledgements**
186
 
187
+ This work was done with the support of the European Space Agency (ESA) under the project “Explainable AI: application to
188
+ trustworthy super-resolution (OpenSR).” Cesar Aybar acknowledges support by the National Council of Science, Technology,
189
+ and Technological Innovation (CONCYTEC, Peru) through the “PROYECTOS DE INVESTIGACIÓN BÁSICA – 2023-01” program with
190
+ contract number PE501083135-2023-PROCIENCIA. Luis Gómez-Chova acknowledges support from the Spanish Ministry of Science
191
+ and Innovation (project PID2019-109026RB-I00 funded by MCIN/AEI/10.13039/501100011033).