diff --git a/CHANGELOG.md b/CHANGELOG.md index c409f57..e9185c0 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,5 @@ # Changelog + All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), @@ -10,15 +11,48 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - `solar_illumination` field for the solar illumination value of the asset. - Added new common names for `rededge700`, `rededge725`, `rededge750` and `rededge775` +- `eo:cloud_cover` and `eo:snow_cover` can be used in bands +- `eo:common_name`, `eo:center_wavelength`, `eo:full_width_half_max` and `eo:solar_illumination` + can be used in Assets and Item Properties ### Changed -### Deprecated +- `eo:bands` is now using the more general `bands` construct from STAC common metadata +- The following fields in the Band Object have been moved/renamed: + - `name` and `description` were *not* renamed, but have been moved to STAC common metadata + - `common_name` has been renamed to `eo:common_name` + - `center_wavelength` has been renamed to `eo:center_wavelength` + - `full_width_half_max` has been renamed to `eo:full_width_half_max` + - `solar_illumination` has been renamed to `eo:solar_illumination` +- The bands in Item Properties are not meant to be the union of the asset bands any longer + You usually don't list bands in Item Properties any longer unless all assets have the same bands. ### Removed +- `eo:bands` - use `bands` instead + ### Fixed +- Clarified how the coverages `eo:cloud_cover` and `eo:snow_cover` should be computed + +## [v1.1.0] - 2023-02-10 + +### Added + +- `solar_illumination` field for the solar illumination value of the band. +- `eo:snow_cover` field for the snow and ice cover value of the entire scene. +- Example for a Collection + +### Changed + +- Defined minimum values for `center_wavelength` and `full_width_half_max` (> 0) + +### Fixed + +- Updated Item example to STAC v1.0.0 +- Fixed wavelength and FWHM values in the examples +- Added `description` to the JSON Schema. + ## [v1.0.0] - 2021-03-30 Initial independent release, see [previous history](https://github.com/radiantearth/stac-spec/commits/v1.0.0-rc.2/extensions/eo) @@ -27,5 +61,6 @@ Initial independent release, see [previous history](https://github.com/radiantea - `common_name` is validated as an enum (no other values allowed) -[Unreleased]: +[Unreleased]: +[v1.1.0]: [v1.0.0]: diff --git a/README.md b/README.md index 004ff7c..b39c696 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # Electro-Optical Extension Specification - **Title:** Electro-Optical -- **Identifier:** +- **Identifier:** - **Field Name Prefix:** eo - **Scope:** Item, Collection - **Extension [Maturity Classification](https://github.com/radiantearth/stac-spec/tree/master/extensions/README.md#extension-maturity):** Stable @@ -16,103 +16,105 @@ could consist of multiple spectral bands in any part of the electromagnetic spec data include sensors with visible, short-wave and mid-wave IR bands (e.g., the OLI instrument on Landsat-8), long-wave IR bands (e.g. TIRS aboard Landsat-8). -It is strongly recommended to use [Instrument Fields](https://github.com/radiantearth/stac-spec/tree/master/item-spec/common-metadata.md#instrument) +It is strongly recommended to use [Instrument Fields](https://github.com/radiantearth/stac-spec/tree/master/item-spec/common-metadata.md#instrument) with the EO extension, to provide information about the platform (satellite, aerial, etc) used to capture the images. -For defining view geometry of data, it is strongly recommended to use the [`view` extension](https://github.com/stac-extensions/view). +For defining view geometry of data, it is strongly recommended to use the [View Extension](https://github.com/stac-extensions/view). - Examples: + - [Collection example](examples/collection.json) - [Item example](examples/item.json) - [JSON Schema](json-schema/schema.json) - [Changelog](./CHANGELOG.md) -## Item Properties or Asset Fields +## Fields -| Field Name | Type | Description | -| -------------- | ------------------------------ | ----------- | -| eo:bands | \[[Band Object](#band-object)] | An array of available bands where each object is a [Band Object](#band-object). If given, requires at least one band. | -| eo:cloud_cover | number | Estimate of cloud cover | +The fields in the table below can be used in these parts of STAC documents: -### Additional Field Information +- [ ] Catalogs +- [ ] Collections +- [x] Item Properties (incl. Summaries in Collections) +- [x] Assets (for both Collections and Items, incl. Item Asset Definitions in Collections) +- [x] Bands +- [ ] Links -#### eo:bands +| Field Name | Type | Description | +| ---------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| eo:cloud_cover | number | Estimate of cloud cover as a percentage (0-100). | +| eo:snow_cover | number | Estimate of snow and ice cover as a percentage (0-100). | +| eo:common_name | string | The name commonly used to refer to the band to make it easier to search for bands across instruments. See the [list of accepted common names](#common-band-names). | +| eo:center_wavelength | number | The center wavelength of the band, in micrometers (μm). | +| eo:full_width_half_max | number | Full width at half maximum (FWHM). The width of the band, as measured at half the maximum transmission, in micrometers (μm). | +| eo:solar_illumination | number | The solar illumination of the band, as measured at half the maximum transmission, in W/m2/micrometers. | -The `eo:bands` array is used to describe the available [spectral -bands](https://www.sciencedirect.com/topics/earth-and-planetary-sciences/spectral-band) in an Asset. This enables clients to read -the file and understand which band is 'red' and which is 'nir' (near infrared) so that it can perform an -[NDVI](https://en.wikipedia.org/wiki/Normalized_difference_vegetation_index) operation, for example. Each Asset should specify -its own band object. If the individual bands are repeated in different assets they should all use the same values and -include the optional [`name`](#name) field to enable clients to easily combine and summarize the bands. - -The `eo:bands` array may optionally be used in the Item Properties to summarize the available bands in the assets. This should -be a 'union' of all the possible bands represented in assets. It should be considered merely informative - clients should rely -on the `eo:bands` of each asset. An Item is only allowed to use `eo:bands` in its Properties if it has at least one asset with -a defined bands array. - -**NOTE**: In STAC versions 0.9.x and prior, `eo:bands` could only be used by an Asset putting the Band Object definitions in -an Item Properties and referencing these via array index. 1.0.0-beta.1 introduced the current behavior. +*At least one of the fields must be specified.* -#### eo:cloud_cover +### Coverages -Estimate of cloud cover as a percentage (0-100) of the entire scene. If not available, the field should not be provided. Generally, -this value should be used in Item Properties rather than Item Assets, as an Item from an electro-optical source is a single snapshot -of the Earth, so the cloud cover value would apply to all assets. +This extension defines some common coverage types (cloud and snow/ice cover) as a percentages (0-100) of the entire scene: +- `eo:cloud_cover` +- `eo:snow_cover` -### Band Object +It is important to consider only the valid data regions, excluding any "nodata" areas while calculating both the coverages. +If such information is not available or can't be calculated, the fields should not be provided. -| Field Name | Type | Description | -| ------------------- | ------ | ----------- | -| name | string | The name of the band (e.g., "B01", "B8", "band2", "red"). | -| common_name | string | The name commonly used to refer to the band to make it easier to search for bands across instruments. See the [list of accepted common names](#common-band-names). | -| description | string | Description to fully explain the band. [CommonMark 0.29](http://commonmark.org/) syntax MAY be used for rich text representation. | -| center_wavelength | number | The center wavelength of the band, in micrometers (μm). | -| full_width_half_max | number | Full width at half maximum (FWHM). The width of the band, as measured at half the maximum transmission, in micrometers (μm). | -| solar_illumination | number | The solar illumination of the band, as measured at half the maximum transmission, in W/m2/micrometers. | +Usually, the properties should be used in Item Properties rather than Item Assets, +as an Item from an electro-optical source is a single snapshot of the Earth, so the coverages usually apply to all assets. -*At least one of the fields must be specified.* +### Spectral Bands -#### name +> \[!NOTE] +> This extension formerly had a field `eo:bands`, which has been removed in favor of a general field `bands` +> in STAC common metadata. The structure is the same, it's an array of Band Objects. +> The fields in the Band Object may change, fields from the EO extension will have a `eo:` prefix, but some more +> general fields like `description` have been moved to common metadata and don't need a prefix and as such don't change. +> Please note that bands in Item Properties are not the union of all bands in the assets any longer. +> If you specify bands in the Item Properties, the bands apply to all assets unless you have a bands object at the asset level. -This is typically the name the data provider uses for the band. It should be treated like an 'id', to identify that a particular -band used in several assets represents the same band (all the other fields should be the same as well). It is also recommended that -clients use this name for display, potentially in conjunction with the common name. +The presence of one of the `eo:` fields in a Band Object makes the band +"[spectral](https://www.sciencedirect.com/topics/earth-and-planetary-sciences/spectral-band)". +This enables clients to read the file and understand which band is 'red' and which is 'nir' (near infrared) so that it can perform an +[NDVI](https://en.wikipedia.org/wiki/Normalized_difference_vegetation_index) operation, for example. +Each Asset should specify its own band object. +If the individual bands are repeated in different assets they should all use the same values and +include the optional bands `name` field to enable clients to easily combine and summarize the bands. -#### center_wavelength and full_width_half_max +#### eo:center_wavelength and eo:full_width_half_max -These fields are a common way to approximately describe a spectral band. In most cases even these numbers are not as useful as the -`common_name` that should be supplied with the spectral bands, where they exist. For non-standard bands (such as with hyperspectral sensors) +These fields are a common way to approximately describe a spectral band. In most cases even these numbers are not as useful as the +`eo:common_name` that should be supplied with the spectral bands, where they exist. For non-standard bands (such as with hyperspectral sensors) the wavelength fields indicate where the band is. -Another common way to define a spectral band with a minimum and maximum wavelength, where outside these bounds the transmission is 0%, -and non-zero inside the bounds (e.g., 80%). The maximum transmission of a band is not captured in any of these metrics, +Another common way to define a spectral band with a minimum and maximum wavelength, where outside these bounds the transmission is 0%, +and non-zero inside the bounds (e.g., 80%). The maximum transmission of a band is not captured in any of these metrics, nor is it important in most cases. -However, spectral transmission for a filter does not go from 0% to a constant max value (e.g., 80%) then back to 0%. Such a filter is -referred to as a "top-hat" filter due to it's shape, but does not exist in reality. Thus, the minimum and maximum wavelengths are -typically selected to be the point at which transmission drops below some threshold, and this threshold is often half of the maximum +However, spectral transmission for a filter does not go from 0% to a constant max value (e.g., 80%) then back to 0%. Such a filter is +referred to as a "top-hat" filter due to it's shape, but does not exist in reality. Thus, the minimum and maximum wavelengths are +typically selected to be the point at which transmission drops below some threshold, and this threshold is often half of the maximum transmission. Thus if a filter's maximum transmission is 80%, the min and max thresholds would be the points where the transmission drops below 40%. -The `center_wavelength` of a band is the midpoint between the min and max wavelengths: +The `eo:center_wavelength` of a band is the midpoint between the min and max wavelengths: ```python center_wavelength = (min_wavelength + max_wavelength) / 2 ``` -The `full_width_half_max` (FWHM) is the difference between the min and max wavelengths, +The `eo:full_width_half_max` (FWHM) is the difference between the min and max wavelengths, thus representing the width of the band at half it's maximum transmission. ```python full_width_half_max = max_wavelength - min_wavelength ``` -For example, if we were given a band described as (0.4um - 0.5um) the `center_wavelength` would be 0.45um -and the `full_width_half_max` would be 0.1um. +For example, if we were given a band described as (0.4um - 0.5um) the `eo:center_wavelength` would be 0.45um +and the `eo:full_width_half_max` would be 0.1um. In some cases the full transmission profile is needed, such as when harmonizing between two sensor modalities. It is recommended - that the full spectral profile be included as a link or an asset (preferably at the + that the full spectral profile be included as a link or an asset (preferably at the [Collection](https://github.com/radiantearth/stac-spec/tree/master/collection-spec/collection-spec.md) level). -#### solar_illumination +#### eo:solar_illumination In satellite-based remote sensing applications, the calibration of the sensor recorded top-of-atmosphere reflectance to radiance, or vice-versa, is carried out using a reference spectral solar irradiance value. @@ -126,32 +128,32 @@ For instance, this value is used for optical calibration of an asset (e.g. [ESUN #### Common Band Names -The band's `common_name` is the name that is commonly used to refer to that band's spectral +The band's `eo:common_name` is the name that is commonly used to refer to that band's spectral properties. The table below shows the allowed common names based on the average band range for the band numbers of several popular instruments. -| Common Name | Band Range (μm) | Landsat 5/7 | Landsat 8 | Sentinel 2 | MODIS | NAIP | -| ----------- | --------------- | ----------- | --------- | ---------- | ----- | ---- | -| coastal | 0.40 - 0.45 | | 1 | 1 | | | -| blue | 0.45 - 0.50 | 1 | 2 | 2 | 3 | 3 | -| green | 0.50 - 0.60 | 2 | 3 | 3 | 4 | 2 | -| red | 0.60 - 0.70 | 3 | 4 | 4 | 1 | 1 | -| yellow | 0.58 - 0.62 | | | | | | -| pan | 0.50 - 0.70 | 8 (*L7 only*) | 8 | | | | -| rededge | 0.70 - 0.79 | | | | | | -| rededge700 | 0.70 - 0.72 | | | 5 | | | -| rededge725 | 0.72 - 0.74 | | | 5 | | | -| rededge750 | 0.74 - 0.76 | | | 6 | | | -| rededge775 | 0.76 - 0.79 | | | 7 | | | -| nir | 0.75 - 1.00 | 4 | | 8 | 2 | 4 | -| nir08 | 0.75 - 0.90 | | 5 | 8a | | | -| nir09 | 0.85 - 1.05 | | | 9 | | | -| cirrus | 1.35 - 1.40 | | 9 | 10 | 26 | | -| swir16 | 1.55 - 1.75 | 5 | 6 | 11 | 6 | | -| swir22 | 2.10 - 2.30 | 7 | 7 | 12 | 7 | | -| lwir | 10.5 - 12.5 | 6 | | | | | -| lwir11 | 10.5 - 11.5 | | 10 | | 31 | | -| lwir12 | 11.5 - 12.5 | | 11 | | 32 | | +| Common Name | Band Range (μm) | Landsat 5/7 | Landsat 8 | Sentinel 2 | MODIS | NAIP | +| ----------- | --------------- | ------------- | --------- | ---------- | ----- | ---- | +| coastal | 0.40 - 0.45 | | 1 | 1 | | | +| blue | 0.45 - 0.50 | 1 | 2 | 2 | 3 | 3 | +| green | 0.50 - 0.60 | 2 | 3 | 3 | 4 | 2 | +| red | 0.60 - 0.70 | 3 | 4 | 4 | 1 | 1 | +| yellow | 0.58 - 0.62 | | | | | | +| pan | 0.50 - 0.70 | 8 (*L7 only*) | 8 | | | | +| rededge | 0.70 - 0.79 | | | 5, 6, 7 | | | +| rededge700 | 0.70 - 0.72 | | | 5 | | | +| rededge725 | 0.72 - 0.74 | | | 5 | | | +| rededge750 | 0.74 - 0.76 | | | 6 | | | +| rededge775 | 0.76 - 0.79 | | | 7 | | | +| nir | 0.75 - 1.00 | 4 | | 8 | 2 | 4 | +| nir08 | 0.75 - 0.90 | | 5 | 8a | | | +| nir09 | 0.85 - 1.05 | | | 9 | | | +| cirrus | 1.35 - 1.40 | | 9 | 10 | 26 | | +| swir16 | 1.55 - 1.75 | 5 | 6 | 11 | 6 | | +| swir22 | 2.10 - 2.30 | 7 | 7 | 12 | 7 | | +| lwir | 10.5 - 12.5 | 6 | | | | | +| lwir11 | 10.5 - 11.5 | | 10 | | 31 | | +| lwir12 | 11.5 - 12.5 | | 11 | | 32 | | The difference between the `nir`, `nir08`, and `nir09` bands are that the `nir` band is a wider band that covers most of the spectral range of 0.75μm to 1.0μm. `nir08` and `nir09` are narrow bands centered 0.85μm and 0.95μm @@ -162,17 +164,17 @@ respectively. The same goes for the difference between: ## Best Practices One of the emerging best practices is to use [Asset Roles](https://github.com/radiantearth/stac-spec/tree/master/item-spec/item-spec.md#asset-roles) -to provide clients with more information about the assets in an item. The following list includes a shared vocabulary for some common EO assets. +to provide clients with more information about the assets in an item. The following list includes a shared vocabulary for some common EO assets. This list should not be considered definitive, and implementors are welcome to use other asset roles. If consensus and tooling consolidates around these role names then they will be specified in the future as more standard than just 'best practices'. -| Role Name | Description | -| --------- | ---------------------------------------------------------------------- | -| reflectance | An asset the provides [reflectance](https://www.l3harrisgeospatial.com/Support/Self-Help-Tools/Help-Articles/Help-Articles-Detail/ArtMID/10220/ArticleID/19247/3377) values, instead of just radiance. | -| temperature | An asset that provides actual temperature measurements. | -| saturation | Points to a file that indicates where pixels in the input spectral bands are saturated. | -| cloud | Points to a file that indicates whether a pixel is assessed as being cloud | -| cloud-shadow | Points to a file that indicates whether a pixel is assessed as being cloud shadow. | +| Role Name | Description | +| ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| reflectance | An asset the provides [reflectance](https://www.l3harrisgeospatial.com/Support/Self-Help-Tools/Help-Articles/Help-Articles-Detail/ArtMID/10220/ArticleID/19247/3377) values, instead of just radiance. | +| temperature | An asset that provides actual temperature measurements. | +| saturation | Points to a file that indicates where pixels in the input spectral bands are saturated. | +| cloud | Points to a file that indicates whether a pixel is assessed as being cloud | +| cloud-shadow | Points to a file that indicates whether a pixel is assessed as being cloud shadow. | ## Contributing @@ -184,16 +186,18 @@ for running tests are copied here for convenience. ### Running tests -The same checks that run as checks on PR's are part of the repository and can be run locally to verify that changes are valid. +The same checks that run as checks on PR's are part of the repository and can be run locally to verify that changes are valid. To run tests locally, you'll need `npm`, which is a standard part of any [node.js installation](https://nodejs.org/en/download/). -First you'll need to install everything with npm once. Just navigate to the root of this repository and on +First you'll need to install everything with npm once. Just navigate to the root of this repository and on your command line run: + ```bash npm install ``` Then to check markdown formatting and test the examples against the JSON schema, you can run: + ```bash npm test ``` @@ -201,6 +205,7 @@ npm test This will spit out the same texts that you see online, and you can then go and fix your markdown or examples. If the tests reveal formatting problems with the examples, you can fix them with: + ```bash npm run format-examples ``` diff --git a/examples/collection.json b/examples/collection.json new file mode 100644 index 0000000..797e49f --- /dev/null +++ b/examples/collection.json @@ -0,0 +1,166 @@ +{ + "id": "eo-collection", + "type": "Collection", + "stac_extensions": [ + "https://stac-extensions.github.io/item-assets/v1.0.0/schema.json", + "https://stac-extensions.github.io/eo/v1.1.0/schema.json" + ], + "stac_version": "1.0.0", + "description": "A simple Collection demonstrating EO extension fields in a Collection.", + "title": "Simple EO Collection", + "extent": { + "spatial": { + "bbox": [ + [ + 172.91173669923782, + 1.3438851951615003, + 172.95469614953714, + 1.3690476620161975 + ] + ] + }, + "temporal": { + "interval": [ + [ + "2020-12-11T22:38:32.125Z", + "2020-12-14T18:02:31.437Z" + ] + ] + } + }, + "license": "CC-BY-4.0", + "summaries": { + "platform": [ + "cool_sat1", + "cool_sat2" + ], + "constellation": [ + "ion" + ], + "instruments": [ + "cool_sensor_v1", + "cool_sensor_v2" + ], + "eo:cloud_cover": { + "minimum": 0, + "maximum": 50 + }, + "bands": [ + { + "name": "band1", + "eo:common_name": "blue", + "eo:center_wavelength": 0.47, + "eo:full_width_half_max": 0.07, + "eo:solar_illumination": 1959.66 + }, + { + "name": "band2", + "eo:common_name": "green", + "eo:center_wavelength": 0.56, + "eo:full_width_half_max": 0.08, + "eo:solar_illumination": 1823.24 + }, + { + "name": "band3", + "eo:common_name": "red", + "eo:center_wavelength": 0.645, + "eo:full_width_half_max": 0.09, + "eo:solar_illumination": 1512.06 + }, + { + "name": "band4", + "eo:common_name": "nir", + "eo:center_wavelength": 0.8, + "eo:full_width_half_max": 0.152, + "eo:solar_illumination": 1041.63 + } + ] + }, + "links": [ + { + "rel": "root", + "href": "./collection.json", + "type": "application/json", + "title": "Simple Example Collection" + }, + { + "rel": "item", + "href": "./item.json", + "type": "application/geo+json", + "title": "20201211_223832_CS2" + } + ], + "item_assets": { + "analytic": { + "type": "image/tiff; application=geotiff; profile=cloud-optimized", + "title": "4-Band Analytic", + "roles": [ + "data" + ], + "bands": [ + { + "name": "band1", + "eo:common_name": "blue", + "eo:center_wavelength": 0.47, + "eo:full_width_half_max": 0.7, + "eo:solar_illumination": 1959.66 + }, + { + "name": "band2", + "eo:common_name": "green", + "eo:center_wavelength": 0.56, + "eo:full_width_half_max": 0.08, + "eo:solar_illumination": 1823.24 + }, + { + "name": "band3", + "common_name": "red", + "eo:center_wavelength": 0.645, + "eo:full_width_half_max": 0.9, + "eo:solar_illumination": 1512.06 + }, + { + "name": "band4", + "eo:common_name": "nir", + "eo:center_wavelength": 0.8, + "eo:full_width_half_max": 0.152, + "eo:solar_illumination": 1041.63 + } + ] + }, + "thumbnail": { + "title": "Thumbnail", + "type": "image/png", + "roles": [ + "thumbnail" + ] + }, + "visual": { + "type": "image/tiff; application=geotiff; profile=cloud-optimized", + "title": "3-Band Visual", + "roles": [ + "visual" + ], + "bands": [ + { + "name": "band3", + "eo:common_name": "red", + "eo:center_wavelength": 0.645, + "eo:full_width_half_max": 0.09 + }, + { + "name": "band2", + "eo:common_name": "green", + "eo:center_wavelength": 0.56, + "eo:full_width_half_max": 0.08 + }, + { + "name": "band1", + "eo:common_name": "blue", + "eo:center_wavelength": 0.47, + "eo:full_width_half_max": 0.07 + } + ] + } + } +} diff --git a/examples/item.json b/examples/item.json index a8381c9..98794a3 100644 --- a/examples/item.json +++ b/examples/item.json @@ -1,7 +1,7 @@ { - "stac_version": "1.0.0-rc.1", + "stac_version": "1.0.0", "stac_extensions": [ - "https://stac-extensions.github.io/eo/v1.0.0/schema.json" + "https://stac-extensions.github.io/eo/v1.1.0/schema.json" ], "type": "Feature", "id": "20201211_223832_CS2", @@ -47,9 +47,30 @@ "cool_sensor_v1" ], "gsd": 0.66, - "eo:cloud_cover": 1.2 + "eo:cloud_cover": 1.2, + "eo:snow_cover": 0 }, - "links": [], + "collection": "eo-collection", + "links": [ + { + "rel": "root", + "href": "./collection.json", + "type": "application/json", + "title": "Simple Example Collection" + }, + { + "rel": "parent", + "href": "./collection.json", + "type": "application/json", + "title": "Simple Example Collection" + }, + { + "rel": "collection", + "href": "./collection.json", + "type": "application/json", + "title": "Simple Example Collection" + } + ], "assets": { "analytic": { "href": "https://storage.googleapis.com/open-cogs/stac-examples/20201211_223832_CS2_analytic.tif", @@ -58,34 +79,35 @@ "roles": [ "data" ], - "eo:bands": [ + "eo:cloud_cover": 1.2, + "bands": [ { "name": "band1", - "common_name": "blue", - "center_wavelength": 470, - "full_width_half_max": 70, - "solar_illumination": 1959.66 + "eo:common_name": "blue", + "eo:center_wavelength": 0.47, + "eo:full_width_half_max": 0.07, + "eo:solar_illumination": 1959.66 }, { "name": "band2", - "common_name": "green", - "center_wavelength": 560, - "full_width_half_max": 80, - "solar_illumination": 1823.24 + "eo:common_name": "green", + "eo:center_wavelength": 0.56, + "eo:full_width_half_max": 0.08, + "eo:solar_illumination": 1823.24 }, { "name": "band3", - "common_name": "red", - "center_wavelength": 645, - "full_width_half_max": 90, - "solar_illumination": 1512.06 + "eo:common_name": "red", + "eo:center_wavelength": 0.645, + "eo:full_width_half_max": 0.09, + "eo:solar_illumination": 1512.06 }, { "name": "band4", - "common_name": "nir", - "center_wavelength": 800, - "full_width_half_max": 152, - "solar_illumination": 1041.63 + "eo:common_name": "nir", + "eo:center_wavelength": 0.8, + "eo:full_width_half_max": 0.152, + "eo:solar_illumination": 1041.63 } ] }, @@ -104,24 +126,24 @@ "roles": [ "visual" ], - "eo:bands": [ + "bands": [ { "name": "band3", - "common_name": "red", - "center_wavelength": 645, - "full_width_half_max": 90 + "eo:common_name": "red", + "eo:center_wavelength": 0.645, + "eo:full_width_half_max": 0.09 }, { "name": "band2", - "common_name": "green", - "center_wavelength": 560, - "full_width_half_max": 80 + "eo:common_name": "green", + "eo:center_wavelength": 0.56, + "eo:full_width_half_max": 0.08 }, { "name": "band1", - "common_name": "blue", - "center_wavelength": 470, - "full_width_half_max": 70 + "eo:common_name": "blue", + "eo:center_wavelength": 0.47, + "eo:full_width_half_max": 0.07 } ] } diff --git a/json-schema/schema.json b/json-schema/schema.json index c9e45fa..33ca2ef 100644 --- a/json-schema/schema.json +++ b/json-schema/schema.json @@ -1,118 +1,152 @@ { "$schema": "http://json-schema.org/draft-07/schema#", - "$id": "https://stac-extensions.github.io/eo/v1.0.0/schema.json#", + "$id": "https://stac-extensions.github.io/eo/v1.1.0/schema.json#", "title": "EO Extension", "description": "STAC EO Extension for STAC Items.", + "type": "object", + "required": [ + "stac_extensions" + ], + "properties": { + "stac_extensions": { + "type": "array", + "contains": { + "const": "https://stac-extensions.github.io/eo/v1.1.0/schema.json" + } + } + }, "oneOf": [ { "$comment": "This is the schema for STAC Items.", - "allOf": [ - { + "type": "object", + "required": [ + "type", + "properties", + "assets" + ], + "properties": { + "type": { + "const": "Feature" + }, + "properties": { + "$ref": "#/definitions/fields" + }, + "assets": { "type": "object", - "required": [ - "type", - "properties", - "assets" - ], + "additionalProperties": { + "$ref": "#/definitions/fields" + } + } + }, + "anyOf": [ + { "properties": { - "type": { - "const": "Feature" - }, - "properties": { - "$ref": "#/definitions/fields" - }, - "assets": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/fields" - } - } - }, - "$comment": "The if-then-else below checks whether the eo:bands is given in assets or not. If yes, allows eo:bands in properties (else), otherwise, disallows eo:bands in properties (then).", - "if": { - "required": [ - "assets" - ], - "properties": { - "assets": { - "type": "object", - "additionalProperties": { - "properties": { - "eo:bands": false - } - } - } - } - }, - "then": { "properties": { - "properties": { - "properties": { - "eo:bands": false - } - } - } - }, - "else": { - "properties": { - "properties": { - "properties": { - "eo:bands": { - "$ref": "#/definitions/bands" - } - } - } + "$ref": "#/definitions/require_any_or_bands" } } }, { - "$ref": "#/definitions/stac_extensions" + "$ref": "#/definitions/require_in_assets" } ] }, { "$comment": "This is the schema for STAC Collections.", - "allOf": [ + "type": "object", + "required": [ + "type" + ], + "properties": { + "type": { + "const": "Collection" + }, + "assets": { + "$ref": "#/definitions/fields" + }, + "item_assets": { + "$ref": "#/definitions/fields" + } + }, + "anyOf": [ + { + "$ref": "#/definitions/require_in_item_assets" + }, + { + "$ref": "#/definitions/require_in_assets" + }, { - "type": "object", - "required": [ - "type" - ], "properties": { - "type": { - "const": "Collection" - }, - "assets": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/fields" - } - }, - "item_assets": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/fields" - } + "summaries": { + "$ref": "#/definitions/require_any_or_bands" } } - }, - { - "$ref": "#/definitions/stac_extensions" } ] } ], "definitions": { - "stac_extensions": { - "type": "object", + "require_any_or_bands": { + "anyOf": [ + { + "$ref": "#/definitions/require_any" + }, + { + "$ref": "#/definitions/require_in_bands" + } + ] + }, + "require_any": { + "anyOf": [ + {"required": ["eo:cloud_cover"]}, + {"required": ["eo:snow_cover"]}, + {"required": ["eo:common_name"]}, + {"required": ["eo:center_wavelength"]}, + {"required": ["eo:full_width_half_max"]}, + {"required": ["eo:solar_illumination"]} + ] + }, + "require_in_bands": { "required": [ - "stac_extensions" + "bands" ], "properties": { - "stac_extensions": { + "bands": { "type": "array", "contains": { - "const": "https://stac-extensions.github.io/eo/v1.0.0/schema.json" + "$ref": "#/definitions/require_any" + } + } + } + }, + "require_in_assets": { + "required": [ + "assets" + ], + "properties": { + "assets": { + "not": { + "additionalProperties": { + "not": { + "$ref": "#/definitions/require_any_or_bands" + } + } + } + } + } + }, + "require_in_item_assets": { + "required": [ + "item_assets" + ], + "properties": { + "item_assets": { + "not": { + "additionalProperties": { + "not": { + "$ref": "#/definitions/require_any_or_bands" + } + } } } } @@ -120,73 +154,70 @@ "fields": { "type": "object", "properties": { + "bands": { + "type": "array", + "items": { + "$ref": "#/definitions/fields" + } + }, "eo:cloud_cover": { "title": "Cloud Cover", "type": "number", "minimum": 0, "maximum": 100 }, - "eo:bands": { - "$ref": "#/definitions/bands" + "eo:snow_cover": { + "title": "Snow and Ice Cover", + "type": "number", + "minimum": 0, + "maximum": 100 + }, + "eo:common_name": { + "title": "Common Name of the band", + "type": "string", + "enum": [ + "coastal", + "blue", + "green", + "red", + "rededge", + "rededge700", + "rededge725", + "rededge750", + "rededge775", + "yellow", + "pan", + "nir", + "nir08", + "nir09", + "cirrus", + "swir16", + "swir22", + "lwir", + "lwir11", + "lwir12" + ] + }, + "eo:center_wavelength": { + "title": "Center Wavelength", + "type": "number", + "minimumExclusive": 0 + }, + "eo:full_width_half_max": { + "title": "Full Width Half Max (FWHM)", + "type": "number", + "minimumExclusive": 0 + }, + "eo:solar_illumination": { + "title": "Solar Illumination", + "type": "number", + "minimum": 0 } }, "patternProperties": { "^(?!eo:)": {} }, "additionalProperties": false - }, - "bands": { - "title": "Bands", - "type": "array", - "minItems": 1, - "items": { - "title": "Band", - "type": "object", - "minProperties": 1, - "properties": { - "name": { - "title": "Name of the band", - "type": "string" - }, - "common_name": { - "title": "Common Name of the band", - "type": "string", - "enum": [ - "coastal", - "blue", - "green", - "red", - "rededge", - "rededge715", - "rededge745", - "rededge775", - "yellow", - "pan", - "nir", - "nir08", - "nir09", - "cirrus", - "swir16", - "swir22", - "lwir", - "lwir11", - "lwir12" - ] - }, - "center_wavelength": { - "title": "Center Wavelength", - "type": "number" - }, - "full_width_half_max": { - "title": "Full Width Half Max (FWHM)", - "type": "number" - }, - "solar_illumination": { - "title": "Solar Illumination", - "type": "number" - } - } - } } } } \ No newline at end of file diff --git a/package.json b/package.json index feffca7..1bc9818 100644 --- a/package.json +++ b/package.json @@ -1,11 +1,11 @@ { "name": "stac-extensions", - "version": "1.0.0", + "version": "1.1.0", "scripts": { "test": "npm run check-markdown && npm run check-examples", "check-markdown": "remark . -f -r .github/remark.yaml", - "check-examples": "stac-node-validator . --lint --verbose --schemaMap https://stac-extensions.github.io/eo/v1.0.0/schema.json=./json-schema/schema.json", - "format-examples": "stac-node-validator . --format --schemaMap https://stac-extensions.github.io/eo/v1.0.0/schema.json=./json-schema/schema.json" + "check-examples": "stac-node-validator . --lint --verbose --schemaMap https://stac-extensions.github.io/eo/v1.1.0/schema.json=./json-schema/schema.json", + "format-examples": "stac-node-validator . --format --schemaMap https://stac-extensions.github.io/eo/v1.1.0/schema.json=./json-schema/schema.json" }, "dependencies": { "remark-cli": "^8.0.0",