Define product:type and product:timeliness

stac-extensions · Apr 29, 2024 · b0e0192 · b0e0192
1 parent 7fc94d3
commit b0e0192
Show file tree

Hide file tree

Showing 6 changed files with 190 additions and 275 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -16,4 +16,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
-[Unreleased]: <https://github.com/stac-extensions/template/compare/v1.0.0...HEAD>
+[Unreleased]: <https://github.com/stac-extensions/product/compare/v1.0.0...HEAD>
diff --git a/README.md b/README.md
@@ -1,14 +1,15 @@
-# Template Extension Specification
+# Product Extension Specification
 
-- **Title:** Template
-- **Identifier:** <https://stac-extensions.github.io/template/v1.0.0/schema.json>
-- **Field Name Prefix:** template
+- **Title:** Product
+- **Identifier:** <https://stac-extensions.github.io/product/v0.1.0/schema.json>
+- **Field Name Prefix:** product
 - **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**: @m-mohr
 
-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 Product Extension to the [SpatioTemporal Asset Catalog](https://github.com/radiantearth/stac-spec) (STAC) specification.
+
+This extension provides a generic framework to describe products across domains better in STAC.
 
 - Examples:
   - [Item example](examples/item.json): Shows the basic usage of the extension in a STAC Item
@@ -26,36 +27,19 @@ The fields in the table below can be used in these parts of STAC documents:
 - [x] 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...                        |
+| Field Name         | Type   | Description       |
+| ------------------ | ------ | ----------------- |
+| product:type       | string | The product type. |
+| product:timeliness | string | The timeliness of the product as an [ISO 8601 Duration](https://en.wikipedia.org/wiki/ISO_8601#Durations). |
 
 ### Additional Field Information
 
-#### template:new_field
-
-This is a much more detailed description of the field `template:new_field`...
-
-### XYZ 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... |
-
-## Relation types
+#### product:type
 
-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).
+The product type in this extension is a free-form text that providers can freely use to descibe their product types.
+Some extensions may specify more specific rules for this field.
 
-| Type           | Description                           |
-| -------------- | ------------------------------------- |
-| fancy-rel-type | This link points to a fancy resource. |
+This field superceedes the `sar:product_type` field.
 
 ## Contributing
 

diff --git a/examples/collection.json b/examples/collection.json
@@ -1,8 +1,7 @@
 {
   "stac_version": "1.0.0",
   "stac_extensions": [
-    "https://stac-extensions.github.io/item-assets/v1.0.0/schema.json",
-    "https://stac-extensions.github.io/template/v1.0.0/schema.json"
+    "https://stac-extensions.github.io/product/v0.1.0/schema.json"
   ],
   "type": "Collection",
   "id": "collection",
@@ -29,36 +28,15 @@
       ]
     }
   },
-  "template:new_field": "test",
-  "template:xyz": {
-    "x": 1,
-    "y": 2,
-    "z": 3
-  },
-  "template:another_one": [
-    1,
-    2,
-    3
-  ],
-  "assets": {
-    "example": {
-      "href": "https://example.com/examples/file.xyz",
-      "template:new_field": "test"
-    }
-  },
-  "item_assets": {
-    "data": {
-      "roles": [
-        "data"
-      ],
-      "template:new_field": "test"
-    }
-  },
+  "product:type": "GRD",
+  "product:timeliness": "PT3H",
   "summaries": {
-    "datetime": {
-      "minimum": "2015-06-23T00:00:00Z",
-      "maximum": "2019-07-10T13:44:56Z"
-    }
+    "product:type": [
+      "GRD"
+    ],
+    "product:timeliness": [
+      "PT3H"
+    ]
   },
   "links": [
     {

diff --git a/examples/item.json b/examples/item.json
@@ -1,67 +1,95 @@
 {
+  "type": "Feature",
   "stac_version": "1.0.0",
   "stac_extensions": [
-    "https://stac-extensions.github.io/template/v1.0.0/schema.json"
-  ],
-  "type": "Feature",
-  "id": "item",
-  "bbox": [
-    172.9,
-    1.3,
-    173,
-    1.4
+    "https://stac-extensions.github.io/product/v0.1.0/schema.json"
   ],
+  "id": "sentinel-1-example",
+  "properties": {
+    "datetime": "2018-11-03T23:58:55.617217Z",
+    "start_datetime": "2018-11-03T23:58:55.121559Z",
+    "end_datetime": "2018-11-03T23:59:55.112875Z",
+    "platform": "sentinel-1a",
+    "constellation": "sentinel-1",
+    "instruments": [
+      "c-sar"
+    ],
+    "product:type": "GRD",
+    "product:timeliness": "PT3H"
+  },
   "geometry": {
     "type": "Polygon",
     "coordinates": [
       [
         [
-          172.9,
-          1.3
+          -67.071648,
+          -64.72924
         ],
         [
-          173,
-          1.3
+          -65.087479,
+          -56.674374
         ],
         [
-          173,
-          1.4
+          -68.033211,
+          -51.105831
         ],
         [
-          172.9,
-          1.4
+          -70.275032,
+          -59.805672
         ],
         [
-          172.9,
-          1.3
+          -67.071648,
+          -64.72924
         ]
       ]
     ]
   },
-  "properties": {
-    "datetime": "2020-12-11T22:38:32Z",
-    "template:new_field": "test",
-    "template:xyz": {
-      "x": 1,
-      "y": 2,
-      "z": 3
-    },
-    "template:another_one": [
-      1,
-      2,
-      3
-    ]
-  },
   "links": [
     {
-      "href": "https://example.com/examples/item.json",
-      "rel": "self"
+      "rel": "root",
+      "href": "../../catalog.json",
+      "type": "application/json"
+    },
+    {
+      "rel": "parent",
+      "href": "../collection.json",
+      "type": "application/json"
     }
   ],
   "assets": {
-    "data": {
-      "href": "https://example.com/examples/file.xyz",
-      "template:new_field": "test"
+    "noises": {
+      "href": "https://example.com/collections/sentinel-1/items/annotation/calibration/noise-s1a-ew-grd-hh-20181103t235855-20181103t235955-024430-02ad5d-001.xml",
+      "type": "text/xml",
+      "title": "Calibration Schema"
+    },
+    "calibrations": {
+      "href": "https://example.com/collections/sentinel-1/items/annotation/calibration/calibration-s1a-ew-grd-hh-20181103t235855-20181103t235955-024430-02ad5d-001.xml",
+      "type": "text/xml",
+      "title": "Noise Schema"
+    },
+    "products": {
+      "href": "https://example.com/collections/sentinel-1/items/annotation/s1a-ew-grd-hh-20181103t235855-20181103t235955-024430-02ad5d-001.xml",
+      "type": "text/xml",
+      "title": "Product Schema"
+    },
+    "measurement": {
+      "href": "https://example.com/collections/sentinel-1/items/measurement/s1a-ew-grd-hh-20181103t235855-20181103t235955-024430-02ad5d-001.tiff",
+      "type": "image/tiff",
+      "title": "Measurements",
+      "sar:polarizations": [
+        "HH"
+      ]
+    },
+    "thumbnail": {
+      "href": "https://example.com/collections/sentinel-1/items/preview/quick-look.png",
+      "type": "image/png",
+      "title": "Thumbnail"
     }
-  }
-}
+  },
+  "bbox": [
+    -70.275032,
+    -64.72924,
+    -65.087479,
+    -51.105831
+  ]
+}