-
Notifications
You must be signed in to change notification settings - Fork 3
Draft #2
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
Draft #2
Changes from 3 commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,53 +1,93 @@ | ||
| # Template Extension Specification | ||
|
|
||
| - **Title:** Template | ||
| - **Identifier:** <https://stac-extensions.github.io/template/v1.0.0/schema.json> | ||
| - **Field Name Prefix:** template | ||
| - **Title:** Classification | ||
| - **Identifier:** <https://stac-extensions.github.io/classification/v1.0.0/schema.json> | ||
| - **Field Name Prefix:** classification | ||
| - **Scope:** Item, Collection | ||
| - **Extension [Maturity Classification](https://github.com/radiantearth/stac-spec/tree/master/extensions/README.md#extension-maturity):** Proposal | ||
| - **Owner**: @your-gh-handles @person2 | ||
| - **Owner**: @drwelby @mmohr | ||
|
|
||
| This document explains the Classification Extension to the [SpatioTemporal Asset Catalog](https://github.com/radiantearth/stac-spec) (STAC) specification. | ||
|
|
||
| Classification stores metadata that clarifies the values within a dataset. Common uses would be: | ||
|
|
||
| - Describing classes of data, and the values belonging to the class | ||
| - The reverse of the above, as a lookup table mapping values to classes | ||
|
|
||
| This document explains the Template Extension to the [SpatioTemporal Asset Catalog](https://github.com/radiantearth/stac-spec) (STAC) specification. | ||
| This is the place to add a short introduction. | ||
|
|
||
| - Examples: | ||
| - [Item example](examples/item.json): Shows the basic usage of the extension in a STAC Item | ||
| - [Asset example](examples/item.json): Shows the basic usage of the extension in a STAC Item | ||
| - [Collection example](examples/collection.json): Shows the basic usage of the extension in a STAC Collection | ||
| - [JSON Schema](json-schema/schema.json) | ||
| - [Changelog](./CHANGELOG.md) | ||
|
|
||
| ## Item Properties and Collection Fields | ||
| ## Asset Properties | ||
|
|
||
| For single-band rasters | ||
|
|
||
| ## Raster Band (Raster Extension) | ||
|
|
||
| For multiband rasters | ||
|
|
||
| ## Table Column (Table Extension) | ||
|
|
||
| For tabular or vector datasets | ||
|
|
||
| ## Collection Fields | ||
|
|
||
| In `summaries` field | ||
|
|
||
|
|
||
| _naming the field "classes" seems more descriptive but ??_ | ||
|
|
||
| | Field Name | Type | Description | | ||
| | -------------------- | ------------------------- | ----------- | | ||
| | template:new_field | string | **REQUIRED**. Describe the required field... | | ||
| | template:xyz | [XYZ Object](#xyz-object) | Describe the field... | | ||
| | template:another_one | \[number] | Describe the field... | | ||
| | classification:classes | [Class object] | **REQUIRED**. Classes in the dataset | | ||
|
|
||
| ### Additional Field Information | ||
|
|
||
| #### template:new_field | ||
| _Current fields from file:values_ | ||
|
|
||
| ### Class Object | ||
|
|
||
| | Field Name | Type | Description | | ||
| | -------------------- | ------------------------- | ----------- | | ||
| | values | [Any] | **REQUIRED** Values in the class | | ||
|
||
| | summary | string | REQUIRED. A short description of the value(s). | | ||
|
|
||
| This is a much more detailed description of the field `template:new_field`... | ||
|
|
||
| ### XYZ Object | ||
| _"values" is shown as a list of any object. I think that could include Range objects for continuous data_ | ||
|
||
|
|
||
| _@mmohr picked "summary" as distinctive from the "description" field commonly used elsewhere with the expectation that CommonMark would not be used and these descriptions would be short in nature_ | ||
|
|
||
| _"Summaries" are mentioned elsewhere in the STAC spec (https://github.com/radiantearth/stac-spec/blob/master/collection-spec/collection-spec.md#summaries) to summarize data statistically so maybe "description" is OK_ | ||
|
||
|
|
||
|
|
||
| ### _Common fields used elsewhere_ | ||
|
|
||
| | Field Name | Type | Description | | ||
| | -------------------- | ------------------------- | ----------- | | ||
| | name | string | Name of the class | | ||
| | description | string | Description of class | | ||
| | title | string | Like "name" but formatted for display| | ||
|
|
||
| _"Description" vs "Summary" is addressed above_ | ||
|
|
||
| _"name" could be useful as a field to identify a class. If classes are mapped to names ((instead of a list)) it would make classes more machine readable. A field named "name" as optional would be useful when classes don't have names._ | ||
|
|
||
| _"title" in other formats like SLD are useful for generating legends and such, but fall into the category of styling and display and probably should be left to styling files which could be linked as assets._ | ||
|
||
|
|
||
| ### _Other fields suggested in discussions_ | ||
|
|
||
| | Field Name | Type | Description | | ||
| | -------------------- | ------------------------- | ----------- | | ||
| | color | string | Color to display this class | | ||
|
|
||
| _This is another case of using a metadata field for styling and probably should be discouraged._ | ||
|
||
|
|
||
| This is the introduction for the purpose and the content of the XYZ Object... | ||
|
|
||
| | Field Name | Type | Description | | ||
| | ----------- | ------ | ----------- | | ||
| | x | number | **REQUIRED**. Describe the required field... | | ||
| | y | number | **REQUIRED**. Describe the required field... | | ||
| | z | number | **REQUIRED**. Describe the required field... | | ||
|
|
||
| ## Relation types | ||
|
|
||
| The following types should be used as applicable `rel` types in the | ||
| [Link Object](https://github.com/radiantearth/stac-spec/tree/master/item-spec/item-spec.md#link-object). | ||
|
|
||
| | Type | Description | | ||
| | ------------------- | ----------- | | ||
| | fancy-rel-type | This link points to a fancy resource. | | ||
|
|
||
| ## Contributing | ||
|
|
||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is there some content missing here? I'm not quite sure what this is trying to express.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
sort of a checklist