changed field name cycle to orbit_cycle

stac-extensions · May 13, 2024 · 6588783 · 6588783
1 parent 9b9a8b8
commit 6588783
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 13 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -0,0 +1,3 @@
+{
+    "jira-plugin.workingProject": ""
+}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,7 +8,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Added cycle field ([#6](https://github.com/stac-extensions/sat/issues/6))
+- Added `orbit_cycle` field ([#6](https://github.com/stac-extensions/sat/issues/6))
 
 ### Changed
 

diff --git a/README.md b/README.md
@@ -21,14 +21,14 @@ It will often be combined with other extensions that describe the actual data, s
 
 ## Item Properties
 
-| Field Name                            | Type    | Description                                                                                                                                                                                          |
-| ------------------------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| sat:platform_international_designator | string  | The International Designator, also known as COSPAR ID, and NSSDCA ID                                                                                                                                 |
-| sat:orbit_state                       | string  | The state of the orbit. Either `ascending` or `descending` for polar orbiting satellites, or `geostationary` for geosynchronous satellites                                                           |
-| sat:absolute_orbit                    | integer | The absolute orbit number at the time of acquisition.                                                                                                                                                |
-| sat:relative_orbit                    | integer | The relative orbit number at the time of acquisition.                                                                                                                                                |
-| sat:anx_datetime                      | string  | The [Ascending Node](https://en.wikipedia.org/wiki/Orbital_node) Crossing (ANX) time, in UTC. It is formatted according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6). |
-| sat:cycle                             | integer | The number of repeat cycle done by the satellite at the time of the acquisition. [Repeat cycle](https://ltb.itc.utwente.nl/page/498/concept/81577) is the time between two successive identical orbits.                                                                                                                                                                   |
+| Field Name                            | Type    | Description                                                                                                                                                                                             |
+| ------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| sat:platform_international_designator | string  | The International Designator, also known as COSPAR ID, and NSSDCA ID                                                                                                                                    |
+| sat:orbit_state                       | string  | The state of the orbit. Either `ascending` or `descending` for polar orbiting satellites, or `geostationary` for geosynchronous satellites                                                              |
+| sat:absolute_orbit                    | integer | The absolute orbit number at the time of acquisition.                                                                                                                                                   |
+| sat:relative_orbit                    | integer | The relative orbit number at the time of acquisition.                                                                                                                                                   |
+| sat:anx_datetime                      | string  | The [Ascending Node](https://en.wikipedia.org/wiki/Orbital_node) Crossing (ANX) time, in UTC. It is formatted according to [RFC 3339, section 5.6](https://tools.ietf.org/html/rfc3339#section-5.6).    |
+| sat:orbit_cycle                       | integer | The number of repeat cycle done by the satellite at the time of the acquisition. [Repeat cycle](https://ltb.itc.utwente.nl/page/498/concept/81577) is the time between two successive identical orbits. |
 
 *At least one of the fields must be specified.*
 
@@ -67,7 +67,7 @@ reference. Used to quickly compute orbital parameters without having to download
 fly a baseline between 2 satellite acquisition, to find the best candidate in the archive from a post-disaster event (e.g 
 earthquake) scene acquisition for a DInSAR processing.
 
-#### sat:cycle
+#### sat:orbit_cycle
 
 The repeat cycle of the satellite. The repeat cycle is the number of orbits required for the satellite to return to the same
 position in its orbit. It is used to determine the relative orbit number. For instance, a satellite with a 16-day repeat cycle

diff --git a/examples/example-sentinel1.json b/examples/example-sentinel1.json
@@ -54,7 +54,7 @@
     "sat:absolute_orbit": 4892,
     "sat:relative_orbit": 95,
     "sat:anx_datetime": "2015-03-05T04:41:46.5788740Z",
-    "sat:cycle": 407,
+    "sat:orbit_cycle": 407,
     "sar:instrument_mode": "IW",
     "sar:polarizations": [
       "VV",

diff --git a/json-schema/schema.json b/json-schema/schema.json
@@ -49,7 +49,7 @@
                     },
                     {
                       "required": [
-                        "sat:cycle"
+                        "sat:orbit_cycle"
                       ]
                     }
                   ]
@@ -146,7 +146,7 @@
           "type": "string",
           "format": "date-time"
         },
-        "sat:cycle": {
+        "sat:orbit_cycle": {
           "type": "integer",
           "minimum": 1
         }