Skip to content

Commit

Permalink
Merge pull request #374 from radiantearth/0.6.1
Browse files Browse the repository at this point in the history
[WIP] Cherry-picked changes for version 0.6.1
  • Loading branch information
cholmes authored Jan 25, 2019
2 parents 656cf81 + f8c0393 commit 8099a51
Show file tree
Hide file tree
Showing 27 changed files with 135 additions and 128 deletions.
18 changes: 9 additions & 9 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -27,12 +27,12 @@ jobs:
- run:
name: validate
command: |
python ~/stac-validator/stac_validator.py catalog-spec/examples/catalog.json
python ~/stac-validator/stac_validator.py collection-spec/examples/sentinel2.json
python ~/stac-validator/stac_validator.py item-spec/examples/sample.json
python ~/stac-validator/stac_validator.py item-spec/examples/sample-full.json
python ~/stac-validator/stac_validator.py item-spec/examples/sentinel2-sample.json
python ~/stac-validator/stac_validator.py item-spec/examples/planet-sample.json
python ~/stac-validator/stac_validator.py item-spec/examples/landsat8-sample.json
python ~/stac-validator/stac_validator.py item-spec/examples/digitalglobe-sample.json
python ~/stac-validator/stac_validator.py item-spec/examples/CBERS_4_MUX_20181029_177_106_L4.json
stac_validator catalog-spec/examples/catalog.json
stac_validator collection-spec/examples/sentinel2.json
stac_validator item-spec/examples/sample.json
stac_validator item-spec/examples/sample-full.json
stac_validator item-spec/examples/sentinel2-sample.json
stac_validator item-spec/examples/planet-sample.json
stac_validator item-spec/examples/landsat8-sample.json
stac_validator item-spec/examples/digitalglobe-sample.json
stac_validator item-spec/examples/CBERS_4_MUX_20181029_177_106_L4.json
9 changes: 8 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,14 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [Unreleased]
## [v0.6.1] - 2019-01-25

### Fixed
- Added `null` as potential data type to `eo:epsg` in the EO extension.
- Fixed several examples and typos.
- Updated JSON Schema versions for uniformity
- Added OpenEO GEE implementation
- Clarified 'intersects' behavior for STAC API

## [v0.6.0] - 2018-11-06

Expand Down Expand Up @@ -106,6 +112,7 @@ Thanks @hgs-msmith, @matthewhanson, @hgs-trutherford, @rouault, @joshfix, @alkam


[Unreleased]: https://github.com/radiantearth/stac-spec/compare/master...dev
[v0.6.1]: https://github.com/radiantearth/stac-spec/compare/v0.6.0...v0.6.1
[v0.6.0]: https://github.com/radiantearth/stac-spec/compare/v0.5.2...v0.6.0
[v0.5.2]: https://github.com/radiantearth/stac-spec/compare/v0.5.1...v0.5.2
[v0.5.1]: https://github.com/radiantearth/stac-spec/compare/v0.5.0...v0.5.1
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The minimal amount is specified right now, but best practices should emerge with
## Current version and branches

The [master branch](https://github.com/radiantearth/stac-spec/tree/master) is the 'stable' version of the spec. It is currently version
[0.6.0-rc1](https://github.com/radiantearth/stac-spec/milestone/7) of the specification. The
**0.6.1** of the specification. The
[dev](https://github.com/radiantearth/stac-spec/tree/dev) branch is where active development takes place, and may have inconsistent examples.
Whenever dev stabilizes a release is cut and we merge dev in to master. So master should be stable at any given time.
It is possible that there may be small releases in quick succession, especially if they are nice improvements that do
Expand Down
5 changes: 2 additions & 3 deletions api-spec/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ It takes a JSON object that can filter on date and time:
```

This tells the server to return all the catalog items it has that are from the second half of March, 2018 and
that fall within this area:
that intersect with this area:

![swiss_bbox](https://user-images.githubusercontent.com/407017/38382405-b5e69344-38be-11e8-90dc-35738678356d.png)

Expand All @@ -33,8 +33,7 @@ pageable links to iterate through any results past that limit.
## Dynamic Catalog API

The other endpoint that is included as an option in STAC API is `/stac/`, which implements the [STAC Catalog Spec](../catalog-spec/README.md).
See the [Dynamic Catalog](https://github.com/radiantearth/stac-spec/blob/structure_and_cleanup/catalog-spec/catalog-spec.md#dynamic-catalogs)
section of that spec for more information. Implementing this enables tools like
Implementing this enables tools like
[STAC Browser](https://medium.com/@mojodna/a-stac-browser-348a60674061) to use the dynamic catalog, to enable better
discovery through people browsing and search engines crawling.

Expand Down
4 changes: 2 additions & 2 deletions api-spec/STAC-query.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.0.1
info:
title: The SpatioTemporal Asset Catalog API (standalone)
version: 0.6.0
version: 0.6.1
description: >-
This is an OpenAPI definition of the core SpatioTemporal Asset Catalog API
specification. Any service that implements this endpoint to allow search of
Expand Down Expand Up @@ -361,7 +361,7 @@ components:
properties:
stac_version:
type: string
example: 0.6.0
example: 0.6.1
id:
type: string
example: naip
Expand Down
4 changes: 2 additions & 2 deletions api-spec/STAC-standalone.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.0.1
info:
title: The SpatioTemporal Asset Catalog API (standalone)
version: 0.6.0
version: 0.6.1
description: >-
This is an OpenAPI definition of the core SpatioTemporal Asset Catalog API
specification. Any service that implements this endpoint to allow search of
Expand Down Expand Up @@ -329,7 +329,7 @@ components:
properties:
stac_version:
type: string
example: 0.6.0
example: 0.6.1
id:
type: string
example: naip
Expand Down
6 changes: 3 additions & 3 deletions api-spec/WFS3core+STAC.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.0.1
info:
title: The SpatioTemporal Asset Catalog API + WFS3
version: 0.6.0
version: 0.6.1
description: >-
This is an OpenAPI definition of the core SpatioTemporal Asset Catalog API
specification. Any service that implements this endpoint to allow search of
Expand Down Expand Up @@ -488,7 +488,7 @@ components:
properties:
stac_version:
type: string
example: 0.6.0
example: 0.6.1
id:
type: string
example: naip
Expand Down Expand Up @@ -749,7 +749,7 @@ components:
- 'http://www.opengis.net/def/crs/OGC/1.3/CRS84'
stac_version:
type: string
example: 0.6.0
example: 0.6.1
id:
description: 'identifier of the collection used, for example, in URIs'
type: string
Expand Down
2 changes: 1 addition & 1 deletion api-spec/definitions/STAC-collections.fragment.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ components:
properties:
stac_version:
type: string
example: 0.6.0
example: 0.6.1
id:
description: 'identifier of the collection used, for example, in URIs'
type: string
Expand Down
4 changes: 2 additions & 2 deletions api-spec/definitions/STAC-standalone.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.0.1
info:
title: The SpatioTemporal Asset Catalog API (standalone)
version: 0.6.0
version: 0.6.1
description: >-
This is an OpenAPI definition of the core SpatioTemporal Asset Catalog API
specification. Any service that implements this endpoint to allow search of
Expand Down Expand Up @@ -327,7 +327,7 @@ components:
properties:
stac_version:
type: string
example: 0.6.0
example: 0.6.1
id:
type: string
example: naip
Expand Down
4 changes: 2 additions & 2 deletions catalog-spec/catalog-spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ might look something like this:

```json
{
"stac_version": "0.6.0",
"stac_version": "0.6.1",
"id": "NAIP",
"description": "Catalog of NAIP Imagery",
"links": [
Expand All @@ -178,7 +178,7 @@ A typical '_child_' sub-catalog could look similar:

```json
{
"stac_version": "0.6.0",
"stac_version": "0.6.1",
"id": "NAIP",
"description": "Catalog of NAIP Imagery - 30087",
"links": [
Expand Down
2 changes: 1 addition & 1 deletion catalog-spec/examples/catalog.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"stac_version": "0.6.0",
"stac_version": "0.6.1",
"id": "sample",
"title": "Sample catalog",
"description": "This is a very basic sample catalog.",
Expand Down
2 changes: 1 addition & 1 deletion collection-spec/examples/sentinel2.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"stac_version": "0.6.0",
"stac_version": "0.6.1",
"id": "COPERNICUS/S2",
"title": "Sentinel-2 MSI: MultiSpectral Instrument, Level-1C",
"description": "Sentinel-2 is a wide-swath, high-resolution, multi-spectral\nimaging mission supporting Copernicus Land Monitoring studies,\nincluding the monitoring of vegetation, soil and water cover,\nas well as observation of inland waterways and coastal areas.\n\nThe Sentinel-2 data contain 13 UINT16 spectral bands representing\nTOA reflectance scaled by 10000. See the [Sentinel-2 User Handbook](https://sentinel.esa.int/documents/247904/685211/Sentinel-2_User_Handbook)\nfor details. In addition, three QA bands are present where one\n(QA60) is a bitmask band with cloud mask information. For more\ndetails, [see the full explanation of how cloud masks are computed.](https://sentinel.esa.int/web/sentinel/technical-guides/sentinel-2-msi/level-1c/cloud-masks)\n\nEach Sentinel-2 product (zip archive) may contain multiple\ngranules. Each granule becomes a separate Earth Engine asset.\nEE asset ids for Sentinel-2 assets have the following format:\nCOPERNICUS/S2/20151128T002653_20151128T102149_T56MNN. Here the\nfirst numeric part represents the sensing date and time, the\nsecond numeric part represents the product generation date and\ntime, and the final 6-character string is a unique granule identifier\nindicating its UTM grid reference (see [MGRS](https://en.wikipedia.org/wiki/Military_Grid_Reference_System)).\n\nFor more details on Sentinel-2 radiometric resoltuon, [see this page](https://earth.esa.int/web/sentinel/user-guides/sentinel-2-msi/resolutions/radiometric).\n",
Expand Down
3 changes: 2 additions & 1 deletion extensions/commons/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@

A group of STAC Item objects from a single source can share a lot of common metadata. This is especially true with satellite imagery that uses the STAC EO Extension. Rather than including these common metadata fields on every Item, they can be provided into the [STAC Collection](../../collection-spec/README.md) that the STAC Items belong to.

- Examples (missing, PRs welcome)
- [Examples](examples/):
- Landsat 8: An [Item](examples/landsat-item.json) that uses the Commons extension to place shared data in a [Collection](examples/landsat-collection.json).
- JSON Schema (missing, PRs welcome)

## WARNING
Expand Down
2 changes: 1 addition & 1 deletion extensions/commons/examples/landsat-collection.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"description": "Landat 8 imagery radiometrically calibrated and orthorectified using gound points and Digital Elevation Model (DEM) data to correct relief displacement.",
"keywords": "landsat",
"version": "0.1.0",
"stac_version": "0.6.0",
"stac_version": "0.6.1",
"extent": {
"spatial": [
-180,
Expand Down
24 changes: 12 additions & 12 deletions extensions/eo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ It is not necessary, but recommended to use the [Commons extension](../commons/R
| eo:constellation | string | Name of the constellation that the platform belongs to. See below for details. |
| 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:epsg | integer | EPSG code of the datasource, null if no EPSG code. |
| eo:epsg | integer\|null | EPSG code 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). |
| eo:azimuth | number | Viewing azimuth angle. The angle measured from the sub-satellite point (point on the ground below the platform) between the scene center and true north. Measured clockwise from north in degrees (0-360). |
Expand Down Expand Up @@ -58,19 +58,19 @@ there is no valid EPSG code.

### Band Object

| element | type info | 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 below for a list of accepted common names. |
| description | string | Description to fully explain the band. [CommonMark 0.28](http://commonmark.org/) syntax MAY be used for rich text representation. |
| gsd | number | Ground Sample distance, the nominal distance between pixel centers available, in meters. See eo:gsd for more information. Defaults to eo:gsd if not provided. |
| accuracy | number | The expected error between the measured location and the true location of a pixel, in meters on the ground. |
| center_wavelength | number | The center wavelength of the band, in micrometres (μ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 micrometres (μm). |
| 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 below for a list of accepted common names. |
| description | string | Description to fully explain the band. [CommonMark 0.28](http://commonmark.org/) syntax MAY be used for rich text representation. |
| gsd | number | Ground Sample distance, the nominal distance between pixel centers available, in meters. See `eo:gsd` for more information. Defaults to `eo:gsd` if not provided. |
| accuracy | number | The expected error between the measured location and the true location of a pixel, in meters on the ground. |
| 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). |


**full_width_half_max** (FWHM) is a common way to describe the size of a spectral band. It is the
width, in micrometres (μm), of the bandpass measured at a half of the maximum transmission. Thus, if the
width, in micrometers (μm), of the bandpass measured at a half of the maximum transmission. Thus, if the
maximum transmission of the bandpass was 80%, the FWHM is measured as the width of the bandpass at
40% transmission.

Expand All @@ -96,7 +96,7 @@ numbers of several popular instruments.

## Associating assets with bands

Asset definitions that contain band data should reference the band index. Each asset should provide a "eo:bands" property that is an array of 0 based indexes to the correct Band Objects.
Asset definitions that contain band data should reference the band index. Each asset should provide a `eo:bands` property that is an array of 0 based indexes to the correct Band Objects.

### Item `Asset Object` fields
| Field Name | Type | Description |
Expand Down
22 changes: 11 additions & 11 deletions extensions/eo/example-landsat8.json
Original file line number Diff line number Diff line change
Expand Up @@ -48,77 +48,77 @@
"eo:off_nadir": 0,
"eo:bands": [
{
"id": "B1",
"name": "B1",
"common_name": "coastal",
"gsd": 30,
"center_wavelength": 0.44,
"full_width_half_max": 0.02
},
{
"id": "B2",
"name": "B2",
"common_name": "blue",
"gsd": 30,
"center_wavelength": 0.48,
"full_width_half_max": 0.06
},
{
"id": "B3",
"name": "B3",
"common_name": "green",
"gsd": 30,
"center_wavelength": 0.56,
"full_width_half_max": 0.06
},
{
"id": "B4",
"name": "B4",
"common_name": "red",
"gsd": 30,
"center_wavelength": 0.65,
"full_width_half_max": 0.04
},
{
"id": "B5",
"name": "B5",
"common_name": "nir",
"gsd": 30,
"center_wavelength": 0.86,
"full_width_half_max": 0.03
},
{
"id": "B6",
"name": "B6",
"common_name": "swir16",
"gsd": 30,
"center_wavelength": 1.6,
"full_width_half_max": 0.08
},
{
"id": "B7",
"name": "B7",
"common_name": "swir22",
"gsd": 30,
"center_wavelength": 2.2,
"full_width_half_max": 0.2
},
{
"id": "B8",
"name": "B8",
"common_name": "pan",
"gsd": 15,
"center_wavelength": 0.59,
"full_width_half_max": 0.18
},
{
"id": "B9",
"name": "B9",
"common_name": "cirrus",
"gsd": 30,
"center_wavelength": 1.37,
"full_width_half_max": 0.02
},
{
"id": "B10",
"name": "B10",
"common_name": "lwir11",
"gsd": 100,
"center_wavelength": 10.9,
"full_width_half_max": 0.8
},
{
"id": "B11",
"name": "B11",
"common_name": "lwir12",
"gsd": 100,
"center_wavelength": 12,
Expand Down
2 changes: 1 addition & 1 deletion extensions/scientific/example-merraclim.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"stac_version": "0.6.0",
"stac_version": "0.6.1",
"id": "MERRAclim",
"description": "MERRAclim, a high-resolution global dataset of remotely sensed bioclimatic variables for ecological modelling.",
"keywords": [
Expand Down
2 changes: 1 addition & 1 deletion extensions/single-item/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# SIngle Item Extension Specification (`item`)
# Single Item Extension Specification (`item`)

**Extension [Maturity Classification](../README.md#extension-maturity): Proposal**

Expand Down
Loading

0 comments on commit 8099a51

Please sign in to comment.