Skip to content

Commit

Permalink
init readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesfisher-geo committed Nov 13, 2024
1 parent 82c71bf commit dc6fd34
Showing 1 changed file with 37 additions and 14 deletions.
51 changes: 37 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,17 @@
# Template Extension Specification
# COCOJSON Extension Specification

- **Title:** Template
- **Identifier:** <https://stac-extensions.github.io/template/v1.0.0/schema.json>
- **Field Name Prefix:** template
- **Scope:** Item, Collection
- **Title:** COCOJSON
- **Identifier:** <https://stac-extensions.github.io/cocojson/v1.0.0/schema.json>
- **Field Name Prefix:** coco
- **Scope:** Item
- **Extension [Maturity Classification](https://github.com/radiantearth/stac-spec/tree/master/extensions/README.md#extension-maturity):** Proposal
- **Owner**: @your-gh-handles @person2
- **Owner**: @jamesfisher-geo

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.
This document explains the COCOJSON Extension to the [SpatioTemporal Asset Catalog](https://github.com/radiantearth/stac-spec) (STAC) specification.

The COCOJSON format (Common Objects in Context JSON) is a standardized format used to represent object annotations along with metadata including
segmentations masks, pixel bounding boxes, and annotation categories commonly used in computer vision. This extension integrates the standarized
COCOJSON fields into the STAC Item spec, enabling a practitioner to embed COCOJSON annotations within STAC Items.

- Examples:
- [Item example](examples/item.json): Shows the basic usage of the extension in a STAC Item
Expand All @@ -21,24 +24,44 @@ This is the place to add a short introduction.
The fields in the table below can be used in these parts of STAC documents:

- [ ] Catalogs
- [x] Collections
- [ ] Collections
- [x] Item Properties (incl. Summaries in Collections)
- [x] Assets (for both Collections and Items, incl. Item Asset Definitions in Collections)
- [ ] Assets (for both Collections and Items, incl. Item Asset Definitions in Collections)
- [ ] Links

| 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... |
| coco:licenses | \[[License Object](#license-object)\] | **REQUIRED**. Describe the required field... |
| coco:categories | \[[Category Object](#category-object)\] | Describe the field... |
| coco:annotations | \[[Annotation Object](#annotation-object)\] | Describe the field... |

### Additional Field Information

#### template:new_field

This is a much more detailed description of the field `template:new_field`...

### XYZ Object
### License Object

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... |

### Category Object

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... |

### Annotation Object

This is the introduction for the purpose and the content of the XYZ Object...

Expand Down

0 comments on commit dc6fd34

Please sign in to comment.