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.

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

Clarify EO items platform, constellation, and instrument #516

Merged
merged 17 commits into from Aug 8, 2019
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions collection-spec/collection-spec.md
Expand Up @@ -136,7 +136,7 @@ An incomplete Collection:
"properties": {
"eo:gsd": 30,
"eo:platform": "landsat-8",
"eo:instrument": "OLI_TIRS",
"eo:instrument": "oli_tirs",
"eo:off_nadir": 0,
"eo:bands": [
{
Expand Down Expand Up @@ -193,7 +193,7 @@ The merged Item then looks like this:
"eo:gsd": 30,
"eo:platform": "landsat-8",
"eo:constellation": "landsat-8",
"eo:instrument": "OLI_TIRS",
"eo:instrument": "oli_tirs",
"eo:off_nadir": 0,
"eo:bands": [
{
Expand Down
2 changes: 1 addition & 1 deletion collection-spec/examples/landsat-collection.json
Expand Up @@ -43,7 +43,7 @@
"properties": {
"eo:gsd": 30,
"eo:platform": "landsat-8",
"eo:instrument": "OLI_TIRS",
"eo:instrument": "oli_tirs",
"eo:off_nadir": 0,
"eo:bands": [
{
Expand Down
29 changes: 23 additions & 6 deletions extensions/eo/README.md
Expand Up @@ -26,10 +26,10 @@ The exact metadata that would appear in a STAC Collection record will vary depen
| Field Name | Type | Description |
| ---------------- | ------------------------ | ----------- |
| eo:gsd | number | **REQUIRED.** Ground Sample Distance at the sensor. |
| eo:platform | string | **REQUIRED.** Unique name of the specific platform the instrument is attached to. For satellites this would be the name of the satellite (e.g., landsat-8, sentinel-2A), whereas for drones this would be a unique name for the drone. |
| eo:constellation | string | Name of the constellation that the platform belongs to. See below for details. |
Copy link
Collaborator Author

Choose a reason for hiding this comment

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

moved so all REQUIRED are at top

| eo:platform | string | **REQUIRED.** Unique name of the specific platform to which the instrument is attached. |
| eo:instrument | string | **REQUIRED.** Name of instrument or sensor used (e.g., MODIS, ASTER, OLI, Canon F-1). |
| eo:bands | [Band Object] | **REQUIRED.** This is a list of the available bands where each item is a Band Object. |
| eo:constellation | string | Name of the constellation to which the platform belongs. |
| eo:epsg | integer\|null | [EPSG code](http://www.epsg-registry.org/) of the datasource, `null` if no EPSG code. |
| 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:off_nadir | number | Viewing angle. The angle from the sensor between nadir (straight down) and the scene center. Measured in degrees (0-90). |
Expand All @@ -48,12 +48,29 @@ PlanetScope Ortho Tile Product has an `eo:gsd` of 3.7 (or 4 if rounding), even t
3.125. For example, one might choose for WorldView-2 the
Multispectral 20° off-nadir value of 2.07 and for WorldView-3 the Multispectral 20° off-nadir value of 1.38.

**eo:constellation** is the name of the group of satellites that have similar payloads and have their orbits arranged in a way to increase the temporal resolution of acquisitions of data with similar geometric and radiometric characteristics. Examples are the Sentinel-2 [constellation](https://www.esa.int/Our_Activities/Observing_the_Earth/Copernicus/Sentinel-2/Satellite_constellation), which has S2A and S2B and RapidEye. This field allows users to search for Sentinel-2 data, for example, without needing to specify which specific platform the data came from.

**eo:platform** is the unique name of the specific platform the instrument is attached to. For satellites this would
be the name of the satellite, whereas for drones this would be a unique name for the drone. It is recommended that
the value be lowercase with no spaces. Examples include `landsat-8` (Landsat-8), `sentinel-2a` and `sentinel-2b`
(Sentinel-2), `terra` and `aqua` (part of NASA EOS, carrying the MODIS instruments),
`mycorp-uav-034` (hypothetical drone name), and `worldview02` (Maxar/DigitalGlobe WorldView-2).

**eo:instrument** is the name of the sensor used, although for Items which contain data from
multiple sensors this could also name multiple sensors. For example, data from the Landsat-8
multiple sensors this could also name multiple sensors. It is recommended
that the value be lowercase with no spaces. For example, data from the Landsat-8
platform is collected with the OLI sensor as well as the TIRS sensor, but the data is distributed
together and commonly referred to as OLI_TIRS.
together and commonly referred to as OLI_TIRS. Examples include `oli_tirs` (Landsat-8), `msi` (Sentinel-2),
`aster` (Terra), and `modis` (Terra and Aqua).

**eo:constellation** is the name of a logical collection one or more platforms that have similar payloads and have
their orbits arranged in a way to increase the temporal resolution of acquisitions of data with similar geometric and
radiometric characteristics. This field allows users to search for related data sets without needing to specify which
specific platform the data came from, for example, from either of the Sentinel-2 satellites. It is recommended
that the value be lowercase with no spaces. Examples include `landsat-8`
(Landsat-8, a constellation consisting of a single platform), `sentinel-2` ([Sentinel-2](https://www.esa.int/Our_Activities/Observing_the_Earth/Copernicus/Sentinel-2/Satellite_constellation)),
`rapideye` (operated by Planet Labs), and `modis` (NASA EOS satellites Aqua and Terra). In the case of `modis`, this
is technically referring to a pair of sensors on two different satellites, whose data is combined into a series of
related products. Additionally, the Aqua satellite is technically part of the A-Train constellation and Terra is not
part of a constellation, but these combine to form the logical collection referred to as MODIS.

**eo:epsg** - A Coordinate Reference System (CRS) is the native reference system (sometimes called a
'projection') used by the data, and can usually be referenced using an [EPSG code](http://epsg.io).
Expand Down
2 changes: 1 addition & 1 deletion extensions/eo/examples/example-landsat8.json
Expand Up @@ -44,7 +44,7 @@
"landsat:row": 18,
"eo:gsd": 30,
"eo:platform": "landsat-8",
"eo:instrument": "OLI_TIRS",
"eo:instrument": "oli_tirs",
"eo:off_nadir": 0,
"eo:bands": [
{
Expand Down
26 changes: 20 additions & 6 deletions extensions/sar/README.md
Expand Up @@ -18,8 +18,8 @@ The exact metadata that would appear in a STAC Collection record will vary depen

| Field Name | Type | Description |
| ------------------------- | ------------- | ------------------------------------------------------------ |
| sar:platform | string | **REQUIRED.** Unique name of the specific platform the instrument is attached to. For satellites this would be the name of the satellite (e.g., sentinel-1A). |
| sar:constellation | string | Name of the constellation that the platform belongs to. See below for details. |
| sar:platform | string | **REQUIRED.** Unique name of the specific platform to which the instrument is attached. |
| sar:constellation | string | Name of the constellation to which the platform belongs. |
| sar:instrument | string | **REQUIRED.** Name of the sensor used, although for Items which contain data from multiple sensors this could also name multiple sensors. |
| sar:instrument_mode | string | **REQUIRED.** The name of the sensor acquisition mode that is commonly used. This should be the short name, if available. For example, `WV` for "Wave mode" of Sentinel-1 and Envisat ASAR satellites. |
| sar:frequency_band | string | **REQUIRED.** The common name for the frequency band to make it easier to search for bands across instruments. See section "Common Frequency Band Names" for a list of accepted names. |
Expand All @@ -41,13 +41,27 @@ The exact metadata that would appear in a STAC Collection record will vary depen
| sar:relative_orbit | integer | A relative orbit number associated with the acquisition. See below for details. |
| sar:incidence_angle | number | The center incidence angle is the angle defined by the incident radar beam at the scene center and the vertical (normal) to the intercepting surface. Measured in degrees (0-90). |

**sar:absolute_orbit** usually corresponds to the number of orbits elapsed since satellite launch (e.g. ALOS, ERS-1/2, JERS-1, RADARSAT-1 and Sentinel-1). For airborne SAR such as UAVSAR it can be the [Flight ID](http://uavsar.jpl.nasa.gov/cgi-bin/data.pl) or a similar concept. The center orbit number should be specified if readily available, otherwise the orbit number at the start of the flight can be used instead.
**sar:platform** is the unique name of the specific platform the instrument is attached to. For satellites this would
be the name of the satellite, whereas for drones this would be a unique name for the drone. It is recommended that
the value be lowercase with no spaces. Examples include `sentinel-1a` (Sentinel-1) and `envisat` (Envisat).

**sar:constellation** is the name of a logical collection one or more platforms that have similar payloads and have
their orbits arranged in a way to increase the temporal resolution of acquisitions of data with similar geometric and
radiometric characteristics. This field allows users to search for related data sets without needing to specify from
which specific platform the data came. It is recommended that the value be lowercase with no spaces. One example is
the constellation `sentinel-1` (Sentinel-1) consisting of two satellites Sentinel-1A and Sentinel-1B. If a system
consists of only a single satellite, the constellation name is the same as the satellite name, e.g., `envisat`
(Envisat).

**sar:instrument** is the name of the sensor used, although for Items which contain data from multiple sensors this
could also name multiple sensors. It is recommended that the value be lowercase with no spaces. Examples include
`c-sar` (Sentinel-1) and `asar` (Envisat).

**sar:relative_orbit** is a count of orbits from 1 to the number of orbits contained in a repeat cycle, where relative orbit 1 starts from a defined reference for a given satellite. This property is usually not set for airborne SAR such as UAVSAR. The center orbit number should be specified if readily available, otherwise the orbit number at the start of the flight can be used instead.
**sar:polarization** specifies a single polarization or a polarization combination. For single polarized radars one of `HH`, `VV`, `HV` or `VH` must be set. Fully polarimetric radars add all four polarizations to the array. Dual polarized radars and alternating polarization add the corresponding polarizations to the array, for instance for `HH+HV` add both `HH` and `HV`.

**sar:constellation** is the name of the group of satellites that have similar payloads and have their orbits arranged in a way to increase the temporal resolution of acquisitions of data with similar geometric and radiometric characteristics. Examples are the Sentinel-1 [constellation](https://www.esa.int/Our_Activities/Observing_the_Earth/Copernicus/Sentinel-1/Satellite_constellation), which has S1A, S1B, S1C and S1D and RADARSAT, which has RADARSAT-1 and RADARSAT-2. This field allows users to search for Sentinel-1 data, for example, without needing to specify which specific platform the data came from.
**sar:absolute_orbit** usually corresponds to the number of orbits elapsed since satellite launch (e.g. ALOS, ERS-1/2, JERS-1, RADARSAT-1 and Sentinel-1). For airborne SAR such as UAVSAR it can be the [Flight ID](http://uavsar.jpl.nasa.gov/cgi-bin/data.pl) or a similar concept. The center orbit number should be specified if readily available, otherwise the orbit number at the start of the flight can be used instead.

**sar:polarization** specifies a single polarization or a polarization combination. For single polarized radars one of `HH`, `VV`, `HV` or `VH` must be set. Fully polarimetric radars add all four polarizations to the array. Dual polarized radars and alternating polarization add the corresponding polarizations to the array, for instance for `HH+HV` add both `HH` and `HV`.
**sar:relative_orbit** is a count of orbits from 1 to the number of orbits contained in a repeat cycle, where relative orbit 1 starts from a defined reference for a given satellite. This property is usually not set for airborne SAR such as UAVSAR. The center orbit number should be specified if readily available, otherwise the orbit number at the start of the flight can be used instead.

### Common Frequency Band Names

Expand Down
6 changes: 3 additions & 3 deletions extensions/sar/examples/envisat.json
Expand Up @@ -18,9 +18,9 @@
"datetime": "2009-05-20T02:40:46.763325Z",
"dtr:start_datetime": "2009-05-20T02:40:01.042784Z",
"dtr:end_datetime": "2009-05-20T02:41:31.483865Z",
"sar:platform": "Envisat",
"sar:constellation": "Envisat",
"sar:instrument": "ASAR",
"sar:platform": "envisat",
"sar:constellation": "envisat",
"sar:instrument": "asar",
"sar:instrument_mode": "GM",
"sar:polarization": ["HH"],
"sar:resolution_range": 1000,
Expand Down
6 changes: 3 additions & 3 deletions extensions/sar/examples/sentinel1.json
Expand Up @@ -18,9 +18,9 @@
"datetime": "2018-11-03T23:58:55.617217Z",
"dtr:start_datetime": "2018-11-03T23:58:55.121559Z",
"dtr:end_datetime": "2018-11-03T23:59:55.112875Z",
"sar:platform": "Sentinel-1A",
"sar:constellation": "Sentinel-1",
"sar:instrument": "C-SAR",
"sar:platform": "sentinel-1a",
"sar:constellation": "sentinel-1",
"sar:instrument": "c-sar",
"sar:instrument_mode": "EW",
"sar:polarization": ["HH"],
"sar:resolution_range": 50,
Expand Down
6 changes: 3 additions & 3 deletions item-spec/examples/digitalglobe-sample.json
Expand Up @@ -68,16 +68,16 @@
"eo:cloud_cover": 50,
"eo:off_nadir": 18.4,
"eo:azimuth": 34.5,
"eo:platform": "WORLDVIEW02",
"eo:platform": "worldview02",
"eo:sun_elevation": 33.4,
"eo:gsd": 2.047,
"eo:epsg": null,
"dg:catalog_id": "103001004B316600",
"dg:soli": "056823192",
"dg:part": 2,
"dg:platform": "WORLDVIEW02",
"dg:platform": "worldview02",
"dg:product_level": "LV1B",
"dg:product": "WORLDVIEW02_LV1B",
"dg:product": "worldview02_LV1B",
philvarner marked this conversation as resolved.
Show resolved Hide resolved
"datetime": "2015-11-09T18:04:46.000Z"
},
"collection": "dg_worldview02",
Expand Down
4 changes: 3 additions & 1 deletion item-spec/examples/sample-full.json
Expand Up @@ -31,7 +31,9 @@
"eo:sun_azimuth": 168.7,
"eo:cloud_cover": 0.12,
"eo:off_nadir": 1.4,
"eo:platform": "COOLSAT2",
"eo:platform": "coolsat2",
"eo:instrument": "cool_sensor_v1",
"eo:bands": [],
"eo:sun_elevation": 33.4,
"eo:gsd": 0.512,
"cs:type": "scene",
Expand Down