Skip to content

Commit a891b55

Browse files
committed
Clarified that values must be an ordered list and not a set of unordered values. #6
1 parent 8825ebf commit a891b55

File tree

2 files changed

+11
-7
lines changed

2 files changed

+11
-7
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
66

77
## [Unreleased]
88

9+
### Changed
10+
11+
- Clarified that `values` must be an ordered list and not a set of unordered values. [#6](https://github.com/stac-extensions/datacube/issues/11)
12+
913
## [v2.0.0] - 2021-07-26
1014

1115
### Added

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ A spatial dimension in one of the horizontal (x or y) directions.
4747
| axis | string | **REQUIRED.** Axis of the spatial dimension (`x`, `y`). |
4848
| description | string | Detailed multi-line description to explain the dimension. [CommonMark 0.29](http://commonmark.org/) syntax MAY be used for rich text representation. |
4949
| extent | \[number] | **REQUIRED.** Extent (lower and upper bounds) of the dimension as two-element array. Open intervals with `null` are not allowed. |
50-
| values | \[number] | Optionally, a set of all potential values. |
50+
| values | \[number] | Optionally, an ordered list of all values. |
5151
| step | number\|null | The space between the values. Use `null` for irregularly spaced steps. |
5252
| reference_system | string\|number\|object | The spatial reference system for the data, specified as [numerical EPSG code](http://www.epsg-registry.org/), [WKT2 (ISO 19162) string](http://docs.opengeospatial.org/is/18-010r7/18-010r7.html) or [PROJJSON object](https://proj.org/specifications/projjson.html). Defaults to EPSG code 4326. |
5353

@@ -61,12 +61,12 @@ A spatial dimension in vertical (z) direction.
6161
| axis | string | **REQUIRED.** Axis of the spatial dimension, always `z`. |
6262
| description | string | Detailed multi-line description to explain the dimension. [CommonMark 0.29](http://commonmark.org/) syntax MAY be used for rich text representation. |
6363
| extent | \[number\|null\] | If the dimension consists of [ordinal](https://en.wikipedia.org/wiki/Level_of_measurement#Ordinal_scale) values, the extent (lower and upper bounds) of the values as two-element array. Use `null` for open intervals. |
64-
| values | \[number\|string\] | A set of all potential values, especially useful for [nominal](https://en.wikipedia.org/wiki/Level_of_measurement#Nominal_level) values. |
64+
| values | \[number\|string\] | An ordered list of all values, especially useful for [nominal](https://en.wikipedia.org/wiki/Level_of_measurement#Nominal_level) values. |
6565
| step | number\|null | If the dimension consists of [interval](https://en.wikipedia.org/wiki/Level_of_measurement#Interval_scale) values, the space between the values. Use `null` for irregularly spaced steps. |
6666
| unit | string | The unit of measurement for the data, preferably compliant to [UDUNITS-2](https://ncics.org/portfolio/other-resources/udunits2/) units (singular). |
6767
| reference_system | string\|number\|object | The spatial reference system for the data, specified as [numerical EPSG code](http://www.epsg-registry.org/), [WKT2 (ISO 19162) string](http://docs.opengeospatial.org/is/18-010r7/18-010r7.html) or [PROJJSON object](https://proj.org/specifications/projjson.html). Defaults to EPSG code 4326. |
6868

69-
A Vertical Spatial Dimension Object MUST specify an `extent` or a set of `values`. It MAY specify both.
69+
A Vertical Spatial Dimension Object MUST specify an `extent` or `values`. It MAY specify both.
7070

7171
### Temporal Dimension Object
7272

@@ -78,7 +78,7 @@ A temporal dimension based on the ISO 8601 standard. The temporal reference syst
7878
| type | string | **REQUIRED.** Type of the dimension, always `temporal`. |
7979
| description | string | Detailed multi-line description to explain the dimension. [CommonMark 0.29](http://commonmark.org/) syntax MAY be used for rich text representation. |
8080
| extent | \[string\|null] | **REQUIRED.** Extent (lower and upper bounds) of the dimension as two-element array. The dates and/or times must be strings compliant to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). `null` is allowed for open date ranges. |
81-
| values | \[string] | If the dimension consists of set of specific values they can be listed here. The dates and/or times must be strings compliant to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). |
81+
| values | \[string] | If the dimension consists of an ordered list of specific values they can be listed here. The dates and/or times must be strings compliant to [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601). |
8282
| step | string\|null | The space between the temporal instances as [ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations), e.g. `P1D`. Use `null` for irregularly spaced steps. |
8383

8484
### Additional Dimension Object
@@ -90,12 +90,12 @@ An additional dimension that is not `spatial`, but may be `temporal` if the data
9090
| type | string | **REQUIRED.** Custom type of the dimension, never `spatial`. |
9191
| description | string | Detailed multi-line description to explain the dimension. [CommonMark 0.29](http://commonmark.org/) syntax MAY be used for rich text representation. |
9292
| extent | \[number\|null] | If the dimension consists of [ordinal](https://en.wikipedia.org/wiki/Level_of_measurement#Ordinal_scale) values, the extent (lower and upper bounds) of the values as two-element array. Use `null` for open intervals. |
93-
| values | \[number\|string] | A set of all potential values, especially useful for [nominal](https://en.wikipedia.org/wiki/Level_of_measurement#Nominal_level) values. |
93+
| values | \[number\|string] | An ordered list of all values, especially useful for [nominal](https://en.wikipedia.org/wiki/Level_of_measurement#Nominal_level) values. |
9494
| step | number\|null | If the dimension consists of [interval](https://en.wikipedia.org/wiki/Level_of_measurement#Interval_scale) values, the space between the values. Use `null` for irregularly spaced steps. |
9595
| unit | string | The unit of measurement for the data, preferably compliant to [UDUNITS-2](https://ncics.org/portfolio/other-resources/udunits2/) units (singular). |
9696
| reference_system | string | The reference system for the data. |
9797

98-
An Additional Dimension Object MUST specify an `extent` or a set of `values`. It MAY specify both.
98+
An Additional Dimension Object MUST specify an `extent` or `values`. It MAY specify both.
9999

100100
Note on "Additional Dimension" with type `temporal`:
101101
You can distinguish the "Temporal Dimension" from an "Additional Dimension" by checking whether the extent exists and contains strings.
@@ -112,7 +112,7 @@ A *Variable Object* defines a variable (or a multi-dimensional array). The varia
112112
| type | string | **REQUIRED.** Type of the variable, either `data` or `auxiliary`. |
113113
| description | string | Detailed multi-line description to explain the variable. [CommonMark 0.29](http://commonmark.org/) syntax MAY be used for rich text representation. |
114114
| extent | \[number\|string\|null] | If the variable consists of [ordinal](https://en.wikipedia.org/wiki/Level_of_measurement#Ordinal_scale) values, the extent (lower and upper bounds) of the values as two-element array. Use `null` for open intervals. |
115-
| values | \[number\|string] | A set of all potential values, especially useful for [nominal](https://en.wikipedia.org/wiki/Level_of_measurement#Nominal_level) values. |
115+
| values | \[number\|string] | An (ordered) list of all values, especially useful for [nominal](https://en.wikipedia.org/wiki/Level_of_measurement#Nominal_level) values. |
116116
| unit | string | The unit of measurement for the data, preferably compliant to [UDUNITS-2](https://ncics.org/portfolio/other-resources/udunits2/) units (singular). |
117117

118118
**type**: The Variable `type` indicates whether what kind of variable is being described. It has two allowed values:

0 commit comments

Comments
 (0)