diff --git a/README.md b/README.md index bf65d0e..3e4e660 100644 --- a/README.md +++ b/README.md @@ -1,61 +1,101 @@ -# Template Extension Specification +# Sentinel-3 Extension Specification -- **Title:** Template -- **Identifier:** -- **Field Name Prefix:** template +- **Title:** Sentinel-3 +- **Identifier:** +- **Field Name Prefix:** s3 - **Scope:** Item, Collection - **Extension [Maturity Classification](https://github.com/radiantearth/stac-spec/tree/master/extensions/README.md#extension-maturity):** Proposal -- **Owner**: @your-gh-handles @person2 +- **Owner**: @m-mohr -This document explains the Template Extension to the [SpatioTemporal Asset Catalog](https://github.com/radiantearth/stac-spec) (STAC) specification. -This is the place to add a short introduction. +This document explains the Sentinel-3 Extension to the [SpatioTemporal Asset Catalog](https://github.com/radiantearth/stac-spec) (STAC) specification. + +The intention of the first version of the specification is to define the existing behavior of +the properties prefixed with `s3` as created by the [stactools-sentinel3](https://github.com/stactools-packages/sentinel3) package and used by +[Microsoft Planetary Computer](https://planetarycomputer.microsoft.com/api/stac/v1). Future versions +will aspire to standardize fields such as the numerous coverage calculations into separate extensions that are not specific to Sentinel-3. - Examples: - - [Item example](examples/item.json): Shows the basic usage of the extension in a STAC Item - - [Collection example](examples/collection.json): Shows the basic usage of the extension in a STAC Collection -- [JSON Schema](json-schema/schema.json) -- [Changelog](./CHANGELOG.md) + - [Item example](examples/item.json): Shows the basic usage of the extension in a STAC Item (todo) + - [Collection example](examples/collection.json): Shows the basic usage of the extension in a STAC Collection (todo) +- [JSON Schema](json-schema/schema.json) (todo) +- [Changelog](./CHANGELOG.md) (todo) ## Fields The fields in the table below can be used in these parts of STAC documents: - [ ] Catalogs -- [x] Collections +- [ ] Collections - [x] Item Properties (incl. Summaries in Collections) -- [x] Assets (for both Collections and Items, incl. Item Asset Definitions in Collections) +- [ ] Assets (for both Collections and Items, incl. Item Asset Definitions in Collections) - [ ] Links -| Field Name | Type | Description | -| -------------------- | ------------------------- | -------------------------------------------- | -| template:new_field | string | **REQUIRED**. Describe the required field... | -| template:xyz | [XYZ Object](#xyz-object) | Describe the field... | -| template:another_one | \[number] | Describe the field... | +| Field Name | Type | Description | Applies to | +| ------------------------ | --------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | +| s3:product_type | string | One of: `OL_2_WFR___`, `SR_2_WAT___`, `SR_2_LAN___`, `SL_2_FRP___`, `SY_2_V10___`, `OL_2_LFR___`, `SL_2_LST___`, `SY_2_VGP___`, `SL_2_WST___`, `SY_2_SYN___`, `SY_2_AOD___`, `SY_2_VG1___` | all | +| s3:product_name | string | One of: `olci-wfr`, `sral-wat`, `sral-lan`, `slstr-frp`, `synergy-v10`, `olci-lfr`, `slstr-lst`, `synergy-vgp`, `slstr-wst`, `synergy-syn`, `synergy-aod`, `synergy-vg1` | all | +| s3:processing_timeliness | string | One of: `NT`, ... | all | +| s3:bright | number | | olci-wfr | +| s3:coastal | number | | olci-lfr, olci-wfr, slstr-frp, slstr-lst, synergy-vgp, slstr-wst, synergy-syn | +| s3:cosmetic | number | | olci-lfr, olci-wfr, slstr-frp, slstr-lst, slstr-wst | +| s3:dubious_samples | number | | olci-lfr, olci-wfr | +| s3:duplicated | number | | olci-lfr, olci-wfr, slstr-frp, slstr-lst, slstr-wst | +| s3:fresh_inland_water | number | | olci-lfr, olci-wfr, slstr-frp, slstr-lst, synergy-vgp, slstr-wst, synergy-syn | +| s3:invalid | number | | olci-lfr, olci-wfr | +| s3:land | number | | olci-lfr, olci-wfr, sral-wat, sral-lan, slstr-frp, synergy-v10, slstr-lst, synergy-vgp, slstr-wst, synergy-syn, synergy-aod, synergy-vg1 | +| s3:saline_water | number | | olci-lfr, olci-wfr, slstr-frp, slstr-lst, synergy-vgp, slstr-wst, synergy-syn, synergy-aod | +| s3:saturated | number | | olci-lfr, olci-wfr, slstr-frp, slstr-lst, slstr-wst | +| s3:tidal_region | number | | olci-lfr, olci-wfr, slstr-frp, slstr-lst, synergy-vgp, slstr-wst, synergy-syn | +| s3:gsd | see description | **DEPRECATED** [SRAL GSD Object](#sral-gsd-object) used in sral-wat and sral-lan, *integer* used in olci-wfr and olci-lfr, [Synergy GSD Object](#synergy-gsd-object) for synergy-v10, synergy-syn, synergy-aod, synergy-vg1 and synergy-vgp, [SLSTR GSD Object](#slstr-gsd-object) for slstr-lst, slstr-frp and slstr-wst | all | +| s3:lrm_mode | number | | sral-wat, sral-lan | +| s3:sar_mode | number | | sral-wat, sral-lan | +| s3:closed_sea | number | | sral-wat, sral-lan | +| s3:open_ocean | number | | sral-wat, sral-lan | +| s3:continental_ice | number | | sral-wat, sral-lan | +| s3:snow_or_ice | number | **DEPRECATED** use eo:snow_cover instead | synergy-v10, synergy-vgp, synergy-vg1 | +| s3:out_of_range | number | | slstr-lst, slstr-wst | + +- [ ] Catalogs +- [ ] Collections +- [ ] Item Properties (incl. Summaries in Collections) +- [x] Assets (for both Collections and Items, incl. Item Asset Definitions in Collections) +- [ ] Links -### Additional Field Information +| Field Name | Type | Description | +| --------------------- | ------------------------------------------------- | ------------------------------------- | +| s3:shape | [integer] | **DEPRECATED** Use proj:shape instead | +| s3:spatial_resolution | [number] | **DEPRECATED** | +| s3:altimetry_bands | [[Altimetry Band Object](#altimetry-band-object)] | **DEPRECATED** Use eo:bands instead | -#### template:new_field +### Altimetry Band Object -This is a much more detailed description of the field `template:new_field`... +| Field Name | Type | Description | +| ---------------- | ------ | ---------------------- | +| band_width | number | | +| description | string | | +| frequency_band | string | `Ku`, `C`, ... | +| center_frequency | number | e.g. 5.41, 13.575, ... | -### XYZ Object +### SRAL GSD Object -This is the introduction for the purpose and the content of the XYZ Object... +| Field Name | Type | Description | +| ------------ | ------- | ----------- | +| along-track | integer | | +| across-track | integer | | -| Field Name | Type | Description | -| ---------- | ------ | -------------------------------------------- | -| x | number | **REQUIRED**. Describe the required field... | -| y | number | **REQUIRED**. Describe the required field... | -| z | number | **REQUIRED**. Describe the required field... | +### Synergy GSD Object -## Relation types +| Field Name | Type | Description | +| ---------- | ------------------------------------- | ----------- | +| OLCI | integer | | +| SLSTR | [SLSTR GSD Object](#slstr-gsd-object) | | -The following types should be used as applicable `rel` types in the -[Link Object](https://github.com/radiantearth/stac-spec/tree/master/item-spec/item-spec.md#link-object). +### SLSTR GSD Object -| Type | Description | -| -------------- | ------------------------------------- | -| fancy-rel-type | This link points to a fancy resource. | +| Field Name | Type | Description | +| --------------- | ------- | ----------- | +| S1-S6 | integer | | +| S7-S9 and F1-F2 | integer | | ## Contributing