Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Deprecate product_uri and reflectance_conversion_factor #2 #17

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Deprecate product_uri and reflectance_conversion_factor #2 #17

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,8 +13,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Deprecated

- `s2:product_uri` without replacement (could use links to the source data)
- `s2:reflectance_conversion_factor` without replacement
- `s2:generation_time` in favor of `processing:datetime`

- `s2:processing_baseline` in favor of `processing:version`

### Removed
Expand Down
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,11 +35,9 @@ The fields in the table below can be used in these parts of STAC documents:
| --------------------------------------- | -------- | ------------------------------------------------------------ |
| s2:tile_id | string | Tile Identifier |
| s2:datatake_id | string | Datatake Identifier |
| s2:product_uri | string | Product URI |
| s2:datastrip_id | string | Datastrip Identifier |
| s2:product_type | string | Product Type |
| s2:datatake_type | string | Datatake Type |
| s2:reflectance_conversion_factor | number | Reflectance Conversion Factor |
| s2:water_percentage | number | Water Percentage |
| s2:vegetation_percentage | number | Vegetation Percentage |
| s2:thin_cirrus_percentage | number | Thin Cirrus Percentage |
Expand All @@ -52,6 +50,8 @@ The fields in the table below can be used in these parts of STAC documents:
| s2:high_proba_clouds_percentage | number | High Probability Clouds Percentage |
| s2:medium_proba_clouds_percentage | number | Medium Probability Clouds Percentage |
| s2:saturated_defective_pixel_percentage | number | Saturated Defective Pixel Percentage |
| s2:product_uri | string | **DEPRECATED** Product URI |
| s2:reflectance_conversion_factor | number | **DEPRECATED** Reflectance Conversion Factor |
| s2:snow_ice_percentage | number | **DEPRECATED** in favor of `eo:snow_cover`. Snow and Ice Percentage |
| s2:generation_time | datetime | **DEPRECATED** in favor of `processing:datetime`. Generation Time |
| s2:processing_baseline | string | **DEPRECATED** in favor of `processing:version`. [Processing Baseline](https://sentinels.copernicus.eu/web/sentinel/technical-guides/sentinel-2-msi/processing-baseline) |
Expand Down
14 changes: 6 additions & 8 deletions examples/item.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -704,19 +704,18 @@
"msi"
],
"constellation": "Sentinel 2",
"s2:tile_id": "S2A_OPER_MSI_L2A_TL_MSFT_20231107T182159_A043751_T20QRF_N05.09",
"eo:cloud_cover": 4.217,
"eo:snow_cover": 0,
"processing:datetime": "2023-11-07T18:21:59.14490Z",
"processing:version": "05.09",
"sat:orbit_state": "descending",
"sat:relative_orbit": 139,
"s2:tile_id": "S2A_OPER_MSI_L2A_TL_MSFT_20231107T182159_A043751_T20QRF_N05.09",
"s2:datatake_id": "GS2A_20231107T144731_043751_N05.09",
"s2:product_uri": "S2A_MSIL2A_20231107T144731_N0509_R139_T20QRF_20231107T182159.SAFE",
"s2:datastrip_id": "S2A_OPER_MSI_L2A_DS_MSFT_20231107T182159_S20231107T144729_N05.09",
"s2:product_type": "S2MSI2A",
"sat:orbit_state": "descending",
"s2:datatake_type": "INS-NOBS",
"processing:datetime": "2023-11-07T18:21:59.14490Z",
"sat:relative_orbit": 139,
"s2:water_percentage": 95.782292,
"eo:snow_cover": 0,
"processing:version": "05.09",
"s2:vegetation_percentage": 0,
"s2:thin_cirrus_percentage": 0.774645,
"s2:cloud_shadow_percentage": 0,
Expand All @@ -726,7 +725,6 @@
"s2:not_vegetated_percentage": 0.000708,
"s2:degraded_msi_data_percentage": 0,
"s2:high_proba_clouds_percentage": 0.699942,
"s2:reflectance_conversion_factor": 1.01678413954947,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a different key that we should be using for this value? Feels strange to lose information and not just move it to a different key.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No, ESA removes it without replacement. It seems not relevant to the general public.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🤔 strange — it's documented in https://sentinels.copernicus.eu/documents/247904/0/Sentinel-2-product-specifications-document-V14-9.pdf so seems unusual to want to remove it. I guess I'm -0.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's what ESA came up with in recent calls. We should probably wait for the official release of the CDSE STAC API anyway before we merge this.

"s2:medium_proba_clouds_percentage": 2.742413,
"s2:saturated_defective_pixel_percentage": 0
},
Expand Down
2 changes: 0 additions & 2 deletions examples/item2.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,13 +37,11 @@
"grid:code": "MGRS-7HFE",
"view:sun_azimuth": 62.3286549448294,
"view:sun_elevation": 57.292926148638,
"s2:product_uri": "S2A_MSIL2A_20190212T192651_N0212_R013_T07HFE_20201007T160857.SAFE",
"s2:product_type": "S2MSI2A",
"s2:datatake_id": "GS2A_20190212T192651_019029_N02.12",
"s2:datatake_type": "INS-NOBS",
"s2:datastrip_id": "S2A_OPER_MSI_L2A_DS_ESRI_20201007T160858_S20190212T192646_N02.12",
"s2:tile_id": "S2A_OPER_MSI_L2A_TL_ESRI_20201007T160858_A019029_T07HFE_N02.12",
"s2:reflectance_conversion_factor": 1.02763689829235,
"s2:degraded_msi_data_percentage": 0,
"s2:nodata_pixel_percentage": 96.769553,
"s2:saturated_defective_pixel_percentage": 0,
Expand Down
10 changes: 5 additions & 5 deletions json-schema/schema.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,6 @@
"anyOf": [
{ "required": ["s2:tile_id"] },
{ "required": ["s2:datatake_id"] },
{ "required": ["s2:product_uri"] },
{ "required": ["s2:datastrip_id"] },
{ "required": ["s2:product_type"] },
{ "required": ["s2:datatake_type"] },
Expand All @@ -69,8 +68,7 @@
{ "required": ["s2:degraded_msi_data_percentage"] },
{ "required": ["s2:high_proba_clouds_percentage"] },
{ "required": ["s2:medium_proba_clouds_percentage"] },
{ "required": ["s2:saturated_defective_pixel_percentage"] },
{ "required": ["s2:reflectance_conversion_factor"] }
{ "required": ["s2:saturated_defective_pixel_percentage"] }
]
},
"fields": {
Expand All @@ -91,7 +89,8 @@
},
"s2:product_uri": {
"title": "Product URI",
"type": "string"
"type": "string",
"deprecated": true
},
"s2:datastrip_id": {
"title": "Datastrip Identifier",
Expand Down Expand Up @@ -211,7 +210,8 @@
},
"s2:reflectance_conversion_factor": {
"title": "Reflectance Conversion Factor",
"type": "number"
"type": "number",
"deprecated": true
},
"s2:mgrs_tile": {
"title": "Sentinel-2 MGRS Tile Identifier",
Expand Down
Loading