Skip to content

Commit

Permalink
Merge pull request #829 from radiantearth/fix-eo
Browse files Browse the repository at this point in the history
Fix eo:bands and more
  • Loading branch information
matthewhanson authored Jun 2, 2020
2 parents 1732a98 + ddbdbdf commit 16ad2c7
Show file tree
Hide file tree
Showing 15 changed files with 538 additions and 724 deletions.
2 changes: 1 addition & 1 deletion collection-spec/collection-spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ STAC Collections are meant to be compatible with *OGC API - Features* Collection

* [Examples](examples/):
* Sentinel 2: A basic standalone example of a [Collection](examples/sentinel2.json) without items.
* Landsat 8: A [Collection](examples/landsat-collection.json) that holds shared data from an [Item](examples/landsat-item.json).
* Landsat 8: A [Collection](examples/landsat-collection.json) with corresponding Item [Item](../item-spec/examples/landsat8-sample.json).
* [JSON Schema](json-schema/collection.json) - please see the [validation instructions](../validation/README.md)

## Collection fields
Expand Down
1 change: 0 additions & 1 deletion collection-spec/examples/landsat-collection.json
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,6 @@
"summaries": {
"platform": ["landsat-8"],
"instruments": ["oli", "tirs"],
"view:off_nadir": [0],
"gsd": [30],
"eo:bands": [
{
Expand Down
180 changes: 0 additions & 180 deletions collection-spec/examples/landsat-item.json

This file was deleted.

2 changes: 1 addition & 1 deletion extensions/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ An extension can add new fields to STAC entities (content extension), or can add
| [Checksum](checksum/README.md) | checksum | checksum | Item, Catalog, Collection | *Proposal* | Provides a way to specify file checksums for assets and links in Items, Catalogs and Collections. |
| [Collection Assets](collection-assets/README.md) | collection-assets | - | Collection | *Proposal* | Provides a way to specify assets available on the collection-level. |
| [Data Cube](datacube/README.md) | datacube | cube | Item, Collection | *Proposal* | Data Cube related metadata, especially to describe their dimensions. |
| [Electro-Optical](eo/README.md) | eo | eo | Item | *Pilot* | Covers electro-optical data that represents a snapshot of the earth for a single date and time. It could consist of multiple spectral bands, for example visible bands, infrared bands, red edge bands and panchromatic bands. The extension provides common fields like bands, cloud cover, gsd and more. |
| [Electro-Optical](eo/README.md) | eo | eo | Item | *Proposal* | Covers electro-optical data that represents a snapshot of the earth for a single date and time. It could consist of multiple spectral bands, for example visible bands, infrared bands, red edge bands and panchromatic bands. The extension provides common fields like bands, cloud cover, gsd and more. |
| [Item Asset Definition](item-assets/README.md) | item-assets | - | Collection | *Proposal* | Provides a way to specify details about what assets may be found in Items belonging to a collection. |
| [Label](label/README.md) | label | label | Item | *Proposal* | Items that relate labeled AOIs with source imagery |
| [Point Cloud](pointcloud/README.md) | pointcloud | pc | Item | *Proposal* | Provides a way to describe point cloud datasets. The point clouds can come from either active or passive sensors, and data is frequently acquired using tools such as LiDAR or coincidence-matched imagery. |
Expand Down
29 changes: 14 additions & 15 deletions extensions/eo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,38 +4,37 @@
- **Identifier: eo**
- **Field Name Prefix: eo**
- **Scope: Item**
- **Extension [Maturity Classification](../README.md#extension-maturity): Pilot**
- **Extension [Maturity Classification](../README.md#extension-maturity): Proposal**

This document explains the fields of the STAC Electro-Optical (EO) Extension to a STAC Item. EO
data is considered to be data that represents a snapshot of the earth for a single date and time. It
could consist of multiple spectral bands in any part of the electromagnetic spectrum. Examples of EO
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).

**Note:** This extension used to be called Earth Observation with a much broader scope (including
Synthetic Aperture Radar (SAR), etc). The decision was made to limit this to what was already its
natural focus, and encourage other sensors to make their own extensions. Once that happens some of
these fields will evolve to higher level extensions. In the meantime other implementations are welcome
to reuse the names and definitions here.

If the data has been collected by a satellite, it is strongly recommended to use the [`sat` extension](../sat/README.md), which in turn requires the [Instrument Fields](../../item-spec/common-metadata.md#instrument). If the data has been collected on an airborne platform it is strongly recommended to use the [Instrument Fields](../../item-spec/common-metadata.md#instrument).

For defining view geometry of data, it is strongly recommended to use the [`view` extension](../view/README.md).

- [Example (Landsat 8)](examples/example-landsat8.json)
- Examples:
- [Landsat 8 with bands in assets](examples/example-landsat8.json)
- [Example with bands in Item properties](../../item-spec/examples/sample-full.json)
- [Landsat 8 with bands in Item Asset Definition and Collection Summaries](../item-assets/examples/example-landsat8.json)
- [JSON Schema](json-schema/schema.json)

## Item fields

| Field Name | Type | Description |
| ---------------- | ------------------------ | ----------- |
| eo:bands | [[Band Object](#band-object)] | **REQUIRED.** This is a list of the available bands where each item is a [Band Object](#band-object). |
| eo:cloud_cover | number | Estimate of cloud cover as a percentage (0-100) of the entire scene. If not available the field should not be provided. |
| Field Name | Type | Description |
| -------------- | ------------------------------ | ----------- |
| eo:bands | \[[Band Object](#band-object)] | This is a list of the available bands where each item is a [Band Object](#band-object). |
| eo:cloud_cover | number | Estimate of cloud cover as a percentage (0-100) of the entire scene. If not available the field should not be provided. |

**eo:bands**: In previous versions `eo:bands` was allowed to be used on the asset-level referencing via array indices to the actual bands in Item `properties`. Starting with STAC 1.0.0-beta.1 you are now allowed to place the full `eo:bands` array with all Band Object information in Item `assets` as described in general in the [STAC Item](../../item-spec/item-spec.md#additional-fields-for-assets).

### Band Object

| Field Name | Type | Description |
| ------------------- | ------ | ------------------------------------------------------------ |
| Field Name | Type | Description |
| ------------------- | ------ | ----------- |
| name | string | The name of the band (e.g., "B01", "B02", "B1", "B5", "QA"). |
| 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. |
Expand All @@ -60,7 +59,7 @@ numbers of several popular instruments.
| green | 0.50 - 0.60 | 2 | 3 | 3 | 4 |
| red | 0.60 - 0.70 | 3 | 4 | 4 | 1 |
| yellow | 0.58 - 0.62 | | | | |
| pan | 0.50 - 0.70 | 8 (*L7 only*) | 8 | | |
| pan | 0.50 - 0.70 | 8 (*L7 only*) | 8 | | |
| rededge | 0.70 - 0.75 | | | | |
| nir | 0.75 - 1.00 | 4 | | 8 | 2 |
| nir08 | 0.75 - 0.90 | | 5 | 8a | |
Expand Down
Loading

0 comments on commit 16ad2c7

Please sign in to comment.