Skip to content

Commit a63a639

Browse files
m-mohrm-mohr
committed
First draft
1 parent cd35cd8 commit a63a639

6 files changed

Lines changed: 89 additions & 214 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
# Changelog
2+
23
All notable changes to this project will be documented in this file.
34

45
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
@@ -16,4 +17,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
1617

1718
### Fixed
1819

19-
[Unreleased]: <https://github.com/stac-extensions/template/compare/v1.0.0...HEAD>
20+
[Unreleased]: <https://github.com/stac-extensions/instruments/compare/v0.1.0...HEAD>

‎README.md‎

Lines changed: 22 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,20 @@
1-
# Template Extension Specification
1+
# Instruments Extension Specification
22

3-
- **Title:** Template
4-
- **Identifier:** <https://stac-extensions.github.io/template/v0.1.0/schema.json>
5-
- **Field Name Prefix:** template
3+
- **Title:** Instruments
4+
- **Identifier:** <https://stac-extensions.github.io/instruments/v0.1.0/schema.json>
5+
- **Field Name Prefix:** -
66
- **Scope:** Catalog, Collection, Item
77
- **Extension [Maturity Classification](https://github.com/radiantearth/stac-spec/tree/master/extensions/README.md#extension-maturity):** Proposal
8-
- **Owner**: @your-gh-handles @person2
8+
- **Owner**: @m-mohr, @emmanuelmathot
99

1010
This document explains the Template Extension to the [SpatioTemporal Asset Catalog](https://github.com/radiantearth/stac-spec) (STAC) specification.
11-
This is the place to add a short introduction.
11+
12+
This extension adds instruments related code and builds on top of the Instrument fields,
13+
especially `instruments`,
14+
in [common metadata](https://github.com/radiantearth/stac-spec/blob/master/commons/common-metadata.md#instrument).
15+
16+
This extension is a incubator for potential fields to be added to common metadata in a future STAC version.
17+
Thus it has no prefix to ensure backward compatibility once it's added to common metadata.
1218

1319
- Examples:
1420
- [Item example](examples/item.json): Shows the basic usage of the extension in a STAC Item
@@ -20,43 +26,20 @@ This is the place to add a short introduction.
2026

2127
The fields in the table below can be used in these parts of STAC documents:
2228

23-
- [x] Catalogs
24-
- [x] Collections
29+
- [ ] Catalogs
30+
- [ ] Collections
2531
- [x] Item Properties (incl. Summaries in Collections)
2632
- [x] Assets (for both Collections and Items, incl. Item Asset Definitions in Collections and Asset Templates)
27-
- [x] Links (incl. Link Templates)
28-
- [x] Bands
29-
30-
| Field Name | Type | Description |
31-
| -------------------- | ------------------------- | -------------------------------------------- |
32-
| template:new_field | string | **REQUIRED**. Describe the required field... |
33-
| template:xyz | [XYZ Object](#xyz-object) | Describe the field... |
34-
| template:another_one | \[number] | Describe the field... |
35-
36-
### Additional Field Information
37-
38-
#### template:new_field
39-
40-
This is a much more detailed description of the field `template:new_field`...
41-
42-
### XYZ Object
43-
44-
This is the introduction for the purpose and the content of the XYZ Object...
45-
46-
| Field Name | Type | Description |
47-
| ---------- | ------ | -------------------------------------------- |
48-
| x | number | **REQUIRED**. Describe the required field... |
49-
| y | number | **REQUIRED**. Describe the required field... |
50-
| z | number | **REQUIRED**. Describe the required field... |
51-
52-
## Relation types
33+
- [ ] Links (incl. Link Templates)
34+
- [ ] Bands
5335

54-
The following types should be used as applicable `rel` types in the
55-
[Link Object](https://github.com/radiantearth/stac-spec/tree/master/item-spec/item-spec.md#link-object).
36+
| Field Name | Type | Description |
37+
| ---------------- | --------------- | ----------- |
38+
| instrument_modes | \[string\|null] | A list of instrument modes of each instrument listed in `instruments`. |
5639

57-
| Type | Description |
58-
| -------------- | ------------------------------------- |
59-
| fancy-rel-type | This link points to a fancy resource. |
40+
The array entries in `instrument_modes` must be provided in parallel to the array entries provided in `instruments`.
41+
If no instrument mode is available for a specific instrument, then set the array element to `null`.
42+
Don't provide `instrument_modes` if all array elements are `null`.
6043

6144
## Contributing
6245

‎examples/collection.json‎

Lines changed: 19 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
{
22
"stac_version": "1.1.0",
33
"stac_extensions": [
4-
"https://stac-extensions.github.io/template/v0.1.0/schema.json"
4+
"https://stac-extensions.github.io/instruments/v0.1.0/schema.json"
55
],
66
"type": "Collection",
7-
"id": "collection",
8-
"title": "A title",
7+
"id": "instruments",
8+
"title": "Instruments Extension Example",
99
"description": "A description",
1010
"license": "Apache-2.0",
1111
"extent": {
@@ -28,45 +28,30 @@
2828
]
2929
}
3030
},
31-
"template:new_field": "test",
32-
"template:xyz": {
33-
"x": 1,
34-
"y": 2,
35-
"z": 3
36-
},
37-
"template:another_one": [
38-
1,
39-
2,
40-
3
41-
],
42-
"assets": {
43-
"example": {
44-
"href": "https://example.com/examples/file.xyz",
45-
"template:new_field": "test"
46-
}
47-
},
48-
"item_assets": {
49-
"data": {
50-
"roles": [
51-
"data"
52-
],
53-
"template:new_field": "test"
54-
}
55-
},
5631
"summaries": {
57-
"datetime": {
58-
"minimum": "2015-06-23T00:00:00Z",
59-
"maximum": "2019-07-10T13:44:56Z"
60-
}
32+
"constellation": [
33+
"sentinel-3"
34+
],
35+
"platform": [
36+
"sentinel-3a"
37+
],
38+
"instruments": [
39+
"olci",
40+
"slstr"
41+
],
42+
"instrument_modes": [
43+
"olci_mode_exmaple",
44+
"slstr_mode_example"
45+
]
6146
},
6247
"links": [
6348
{
6449
"href": "https://example.com/examples/collection.json",
6550
"rel": "self"
6651
},
6752
{
68-
"href": "https://example.com/examples/item.json",
53+
"href": "./item.json",
6954
"rel": "item"
7055
}
7156
]
72-
}
57+
}

‎examples/item.json‎

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"stac_version": "1.1.0",
33
"stac_extensions": [
4-
"https://stac-extensions.github.io/template/v0.1.0/schema.json"
4+
"https://stac-extensions.github.io/instruments/v0.1.0/schema.json"
55
],
66
"type": "Feature",
77
"id": "item",
@@ -40,28 +40,31 @@
4040
},
4141
"properties": {
4242
"datetime": "2020-12-11T22:38:32Z",
43-
"template:new_field": "test",
44-
"template:xyz": {
45-
"x": 1,
46-
"y": 2,
47-
"z": 3
48-
},
49-
"template:another_one": [
50-
1,
51-
2,
52-
3
43+
"constellation": "sentinel-3",
44+
"platform": "sentinel-3a",
45+
"instruments": [
46+
"olci",
47+
"slstr"
48+
],
49+
"instrument_modes": [
50+
"olci_mode_exmaple",
51+
"slstr_mode_example"
5352
]
5453
},
5554
"links": [
5655
{
5756
"href": "https://example.com/examples/item.json",
5857
"rel": "self"
58+
},
59+
{
60+
"href": "./collection.json",
61+
"rel": "collection"
5962
}
6063
],
6164
"assets": {
6265
"data": {
63-
"href": "https://example.com/examples/file.xyz",
64-
"template:new_field": "test"
66+
"href": "https://example.com/examples/file.xyz"
6567
}
66-
}
67-
}
68+
},
69+
"collection": "instruments"
70+
}

0 commit comments

Comments
 (0)