Update README.md

README.md

@@ -5,15 +5,17 @@ task_categories:
 language:
 - en
 tags:
-  - earth-observation
-  - remote-sensing
-  - sentinel-2
-  - multi-spectral
-  - satellite
-  - geospatial
+- clouds
+- earth-observation
+- remote-sensing
+- sentinel-2
+- deep-learning
+- multi-spectral
+- satellite
+- geospatial
 pretty_name: cloudsen12
 size_categories:
-  - 100K<n<1M
+- 100K<n<1M
 ---
 
 
@@ -38,32 +40,81 @@ those who prefer traditional storage formats, GeoTIFF files are available in our
 
 *CloudSEN12+ spatial coverage. The terms p509 and p2000 denote the patch size 509 × 509 and 2000 × 2000, respectively. ‘high’, ‘scribble’, and ‘nolabel’ refer to the types of expert-labeled annotations*
 
-## Data Structure
+**ML-STAC Snippet**
+```python
+import mlstac
+dataset = mlstac.load('isp-uv-es/CloudSEN12Plus')
+```
 
-We use `.mlstac` format to store the data in HugginFace and GeoTIFF for ScienceDataBank.
+**Sensor: Sentinel2 - MSI**
 
+**ML-STAC Task: image-segmentation**
 
-Index  | Name | Scale  | Wavelength                      | Description              |
-|------|------|--------|---------------------------------|--------------------------|
-|  0  | B1   | 0.0001 | 443.9 nm (S2A)/442.3 nm (S2B)   | Aerosols.                |
-|  1  | B2   | 0.0001 | 496.6 nm (S2A)/492.1 nm (S2B)   | Blue.                    |
-|  2  | B3   | 0.0001 | 560 nm (S2A)/559 nm (S2B)       | Green.                   |
-|  3  | B4   | 0.0001 | 664.5 nm (S2A)/665 nm (S2B)     | Red.                     |
-|  4  | B5   | 0.0001 | 703.9 nm (S2A)/703.8 nm (S2B)   | Red Edge 1.              |
-|  5  | B6   | 0.0001 | 740.2 nm (S2A)/739.1 nm (S2B)   | Red Edge 2.              |
-|  6  | B7   | 0.0001 | 782.5 nm (S2A)/779.7 nm (S2B)   | Red Edge 3.              |
-|  7  | B8   | 0.0001 | 835.1 nm (S2A)/833 nm (S2B)     | NIR.                     |
-|  8  | B8A  | 0.0001 | 864.8 nm (S2A)/864 nm (S2B)     | Red Edge 4.              |
-|  9  | B9   | 0.0001 | 945 nm (S2A)/943.2 nm (S2B)     | Water vapor.             |
-| 10  | B10  | 0.0001 | 1373.5 nm (S2A)/1376.9 nm (S2B) | Cirrus.                  |
-| 11  | B11  | 0.0001 | 1613.7 nm (S2A)/1610.4 nm (S2B) | SWIR 1.                  |
-| 12  | B12  | 0.0001 | 2202.4 nm (S2A)/2185.7 nm (S2B) | SWIR 2.                  |
-| 13  | CM1  | 1      | -                               | Expert-labeled image.    |
-| 14  | CM2  | 1      | -                               | UnetMobV2-labeled image. |
+**Data raw repository:  [https://cloudsen12.github.io/](https://cloudsen12.github.io/)**
 
+**Dataset discussion:  [https://huggingface.co/datasets/isp-uv-es/CloudSEN12Plus/discussions](https://huggingface.co/datasets/isp-uv-es/CloudSEN12Plus/discussions)**
 
-## Folder Structure
+**Split_strategy:  stratified**
+
+**Paper:  [https://www.sciencedirect.com/science/article/pii/S2352340924008163](https://www.sciencedirect.com/science/article/pii/S2352340924008163)**
+
+
+## Data Providers
+
+|Name|Role|URL|
+| :---: | :---: | :---: |
+|Image & Signal Processing|['host']|https://isp.uv.es/|
+|ESA|['producer']|https://www.esa.int/|
+
+## Curators
+
+|Name|Organization|URL|
+| :---: | :---: | :---: |
+|Cesar Aybar|Image & Signal Processing|http://csaybar.github.io/|
+
+
+## Labels
+
+|Name|Value|
+| :---: | :---: |
+|clear|0|
+|thick-cloud|1|
+|thin-cloud|2|
+|cloud-shadow|3|
+
+## Dimensions
+
+|Axis|Name|Description|
+| :---: | :---: | :---: |
+|0|C|Spectral bands|
+|1|H|Height|
+|2|W|Width|
 
+## Spectral Bands
+
+|Name|Common Name|Description|Center Wavelength|Full Width Half Max|Index|
+| :---: | :---: | :---: | :---: | :---: | :---: |
+|B01|coastal aerosol|Band 1 - Coastal aerosol - 60m|443.5|17.0|0|
+|B02|blue|Band 2 - Blue - 10m|496.5|53.0|1|
+|B03|green|Band 3 - Green - 10m|560.0|34.0|2|
+|B04|red|Band 4 - Red - 10m|664.5|29.0|3|
+|B05|red edge 1|Band 5 - Vegetation red edge 1 - 20m|704.5|13.0|4|
+|B06|red edge 2|Band 6 - Vegetation red edge 2 - 20m|740.5|13.0|5|
+|B07|red edge 3|Band 7 - Vegetation red edge 3 - 20m|783.0|18.0|6|
+|B08|NIR|Band 8 - Near infrared - 10m|840.0|114.0|7|
+|B8A|red edge 4|Band 8A - Vegetation red edge 4 - 20m|864.5|19.0|8|
+|B09|water vapor|Band 9 - Water vapor - 60m|945.0|18.0|9|
+|B10|cirrus|Band 10 - Cirrus - 60m|1375.5|31.0|10|
+|B11|SWIR 1|Band 11 - Shortwave infrared 1 - 20m|1613.5|89.0|11|
+|B12|SWIR 2|Band 12 - Shortwave infrared 2 - 20m|2199.5|173.0|12|
+|CM1| Cloud Mask 1| Expert-labeled image.    |-|-|13|
+|CM2| Cloud Mask 2| UnetMobV2-V1 labeled image. |-|-|14|
+
+## Data Structure
+
+We use `.mls` format to store the data in HugginFace and GeoTIFF for ScienceDataBank.
+
+## Folder Structure
 
 The **fixed/** folder contains high and scribble labels, which have been improved in this new version. These changes have already been integrated.
 
@@ -73,7 +124,48 @@ The **images/** folder contains the CloudSEN12+ imagery
 
 ## Download
 
+The code below can be used to download the dataset using the `mlstac` library. For a more detailed example, please refer to the `examples` section in our
+website [https://cloudsen12.github.io/](https://cloudsen12.github.io/).
+
+
+```python
+import mlstac
+import matplotlib.pyplot as plt
+import numpy as np
+
+ds = mlstac.load(snippet="isp-uv-es/CloudSEN12Plus")
+subset = ds.metadata[(ds.metadata["split"] == "test") & (ds.metadata["label_type"] == "high") & (ds.metadata["proj_shape"] == 509)][10:14]
+datacube = mlstac.get_data(dataset=subset)
+```
+
+Make a plot of the data point downloaded
+
+```python
+datapoint = datacube[2]
+datapoint_rgb = np.moveaxis(datapoint[[3, 2, 1]], 0, -1) / 5_000
+fig, ax = plt.subplots(1, 3, figsize=(10, 5))
+ax[0].imshow(datapoint_rgb)
+ax[0].set_title("RGB")
+ax[1].imshow(datapoint[13], cmap="gray")
+ax[1].set_title("Human label")
+ax[2].imshow(datapoint[14], cmap="gray")
+ax[2].set_title("UnetMobV2 v1.0")
+```
+
+
+![image/png](https://cdn-uploads.huggingface.co/production/uploads/6402474cfa1acad600659e92/scVhZf3rkB3uWkZZ6Epmu.png)
 
 ## Citation
 
-Cooming soon!
+Cite the dataset as:
+
+```bibtex
+@article{aybar2024cloudsen12+,
+  title={CloudSEN12+: The largest dataset of expert-labeled pixels for cloud and cloud shadow detection in Sentinel-2},
+  author={Aybar, Cesar and Bautista, Lesly and Montero, David and Contreras, Julio and Ayala, Daryl and Prudencio, Fernando and Loja, Jhomira and Ysuhuaylas, Luis and Herrera, Fernando and Gonzales, Karen and others},
+  journal={Data in Brief},
+  pages={110852},
+  year={2024},
+  publisher={Elsevier}
+}
+```