Skip to content

Commit 16ad2c7

Browse files
Merge pull request #829 from radiantearth/fix-eo
Fix eo:bands and more
2 parents 1732a98 + ddbdbdf commit 16ad2c7

File tree

15 files changed

+538
-724
lines changed

15 files changed

+538
-724
lines changed

collection-spec/collection-spec.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ STAC Collections are meant to be compatible with *OGC API - Features* Collection
1010

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

1616
## Collection fields

collection-spec/examples/landsat-collection.json

-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,6 @@
6060
"summaries": {
6161
"platform": ["landsat-8"],
6262
"instruments": ["oli", "tirs"],
63-
"view:off_nadir": [0],
6463
"gsd": [30],
6564
"eo:bands": [
6665
{

collection-spec/examples/landsat-item.json

-180
This file was deleted.

extensions/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ An extension can add new fields to STAC entities (content extension), or can add
4949
| [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. |
5050
| [Collection Assets](collection-assets/README.md) | collection-assets | - | Collection | *Proposal* | Provides a way to specify assets available on the collection-level. |
5151
| [Data Cube](datacube/README.md) | datacube | cube | Item, Collection | *Proposal* | Data Cube related metadata, especially to describe their dimensions. |
52-
| [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. |
52+
| [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. |
5353
| [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. |
5454
| [Label](label/README.md) | label | label | Item | *Proposal* | Items that relate labeled AOIs with source imagery |
5555
| [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. |

extensions/eo/README.md

+14-15
Original file line numberDiff line numberDiff line change
@@ -4,38 +4,37 @@
44
- **Identifier: eo**
55
- **Field Name Prefix: eo**
66
- **Scope: Item**
7-
- **Extension [Maturity Classification](../README.md#extension-maturity): Pilot**
7+
- **Extension [Maturity Classification](../README.md#extension-maturity): Proposal**
88

99
This document explains the fields of the STAC Electro-Optical (EO) Extension to a STAC Item. EO
1010
data is considered to be data that represents a snapshot of the earth for a single date and time. It
1111
could consist of multiple spectral bands in any part of the electromagnetic spectrum. Examples of EO
1212
data include sensors with visible, short-wave and mid-wave IR bands (e.g., the OLI instrument on
1313
Landsat-8), long-wave IR bands (e.g. TIRS aboard Landsat-8).
1414

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

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

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

2825
## Item fields
2926

30-
| Field Name | Type | Description |
31-
| ---------------- | ------------------------ | ----------- |
32-
| eo:bands | [[Band Object](#band-object)] | **REQUIRED.** This is a list of the available bands where each item is a [Band Object](#band-object). |
33-
| 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. |
27+
| Field Name | Type | Description |
28+
| -------------- | ------------------------------ | ----------- |
29+
| eo:bands | \[[Band Object](#band-object)] | This is a list of the available bands where each item is a [Band Object](#band-object). |
30+
| 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. |
31+
32+
**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).
3433

3534
### Band Object
3635

37-
| Field Name | Type | Description |
38-
| ------------------- | ------ | ------------------------------------------------------------ |
36+
| Field Name | Type | Description |
37+
| ------------------- | ------ | ----------- |
3938
| name | string | The name of the band (e.g., "B01", "B02", "B1", "B5", "QA"). |
4039
| 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). |
4140
| description | string | Description to fully explain the band. [CommonMark 0.29](http://commonmark.org/) syntax MAY be used for rich text representation. |
@@ -60,7 +59,7 @@ numbers of several popular instruments.
6059
| green | 0.50 - 0.60 | 2 | 3 | 3 | 4 |
6160
| red | 0.60 - 0.70 | 3 | 4 | 4 | 1 |
6261
| yellow | 0.58 - 0.62 | | | | |
63-
| pan | 0.50 - 0.70 | 8 (*L7 only*) | 8 | | |
62+
| pan | 0.50 - 0.70 | 8 (*L7 only*) | 8 | | |
6463
| rededge | 0.70 - 0.75 | | | | |
6564
| nir | 0.75 - 1.00 | 4 | | 8 | 2 |
6665
| nir08 | 0.75 - 0.90 | | 5 | 8a | |

0 commit comments

Comments
 (0)