Skip to content

Commit

Permalink
example formatting
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesfisher-geo committed Nov 13, 2024
1 parent b73fc74 commit f30ff0e
Show file tree
Hide file tree
Showing 3 changed files with 26 additions and 10 deletions.
8 changes: 3 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ The fields in the table below can be used in these parts of STAC documents:
| -------------------- | ------------------------- | -------------------------------------------- |
| 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... |
| coco:annotations | \[[Annotation Object](#annotation-object)\] | Describe the field... |

### Additional Field Information

Expand All @@ -59,7 +59,7 @@ This is the introduction for the purpose and the content of the XYZ Object...
| ---------- | ------ | -------------------------------------------- |
| `id` | number | **REQUIRED**. Integer ID of the category |
| `name` | string | **REQUIRED**. Name of the category (e.g. 'cat') |
| `supercategory` | string | **REQUIRED**. General category (e.g. 'animal') |
| `supercategory` | string | **REQUIRED**. General category (e.g. 'animal') |
<!-- | `keypoints` | /[string/] | List of names which keypoint coordinates represent |
| `skeleton` | /[/[number, number/]/] | **REQUIRED**. Describe the required field... | -->

Expand All @@ -73,13 +73,11 @@ This is the introduction for the purpose and the content of the XYZ Object...
| `image_id` | number | **REQUIRED**. Integer ID of the associated images from the 'coco:images' field |
| `category_id` | number | **REQUIRED**. Integer ID of the associated category from the 'coco:categories' field |
| `bbox` | /[number/] | **REQUIRED**. Bounding box of the annotation in pixel coordinates |
| `segmentation` | /[/[number, number/]/] | Segmentation mask of the annotation as a list of image coordinates |
| `segmentation` | /[/[number, number/]/] | Segmentation mask of the annotation as a list of image coordinates |
| `area` | number | The area of the segmentation mask in pixels |
| `iscrowd` | bool | Tag indicating if the segmentation mask is of a single object or many objects in an image |
| `score` | number | Score 0 - 1.0 indicating the annotation confidence level |



## Contributing

All contributions are subject to the
Expand Down
4 changes: 2 additions & 2 deletions examples/collection.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
},
"assets": {
"example": {
"href": "https://example.com/examples/file.xyz",
"href": "https://example.com/examples/file.xyz"
}
},
"item_assets": {
Expand All @@ -56,4 +56,4 @@
"rel": "item"
}
]
}
}
24 changes: 21 additions & 3 deletions examples/item.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"stac_version": "1.0.0",
"stac_extensions": [
"https://stac-extensions.github.io/cocojson/v1.0.0/schema.json"
"https://stac-extensions.github.io/template/v1.0.0/schema.json"
],
"type": "Feature",
"id": "item",
Expand Down Expand Up @@ -59,8 +59,26 @@
"id": 1,
"image_id": 1,
"category_id": 1,
"bbox": [260, 177, 231, 199],
"segmentation": [[260, 177], [261, 178], [262, 179], ...],
"bbox": [
260,
177,
231,
199
],
"segmentation": [
[
260,
177
],
[
261,
178
],
[
262,
179
]
],
"area": 45969,
"iscrowd": 0,
"score": 0.75
Expand Down

0 comments on commit f30ff0e

Please sign in to comment.