Skip to content

Commit 83060e9

Browse files
committed
rename parameter sections, add Collections section
1 parent 3dde63c commit 83060e9

File tree

4 files changed

+108
-6
lines changed

4 files changed

+108
-6
lines changed

SUMMARY.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@
1515
* [Categorical Parameters](parameter-categories.md)
1616
* [Parameter Groups](parameter-groups.md)
1717
* [Parameter Examples](parameter-examples.md)
18-
* [Argo Quality Flags](parameter-argo-quality-flags.md)
19-
* [Sea Ice Area Fraction](parameter-sea-ice-area-fraction.md)
20-
* [Collections](collection.md)
18+
* [Quality Flags](parameter-quality-flags.md)
19+
* [Fractional Quantities](parameter-fractional-quantities.md)
20+
* [Collections](collections.md)
2121
* [Encoding Advice](encoding-advice.md)
2222
* [Extensions](extensions.md)
2323
* [Custom Fields](custom-fields.md)

collections.md

+102
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,102 @@
1+
# Collections
2+
3+
CoverageJSON has a compact coverage collection structure which allows to move repeated information like parameters and reference systems to the collection level. It is especially useful for uniform collections but can also be used for any other collection where each coverage may have a different set of parameters or reference systems.
4+
5+
Example:
6+
7+
```json
8+
{
9+
"type" : "CoverageCollection",
10+
"domainType" : "VerticalProfile",
11+
"parameters" : {
12+
"PSAL": {
13+
"type" : "Parameter",
14+
"description" : {
15+
"en": "The measured salinity, in practical salinity units (psu) of the sea water"
16+
},
17+
"unit" : {
18+
"symbol" : "psu"
19+
},
20+
"observedProperty" : {
21+
"id": "http://vocab.nerc.ac.uk/standard_name/sea_water_salinity/",
22+
"label" : {
23+
"en": "Sea Water Salinity"
24+
}
25+
}
26+
}
27+
},
28+
"referencing": [{
29+
"components": ["x","y"],
30+
"system": {
31+
"type": "GeodeticCRS",
32+
"id": "http://www.opengis.net/def/crs/OGC/1.3/CRS84"
33+
}
34+
}, {
35+
"components": ["z"],
36+
"system": {
37+
"type": "VerticalCRS",
38+
"cs": {
39+
"axes": [{
40+
"name": {
41+
"en": "Pressure"
42+
},
43+
"direction": "down",
44+
"unit": {
45+
"symbol": "Pa"
46+
}
47+
}]
48+
}
49+
}
50+
}, {
51+
"components": ["t"],
52+
"system": {
53+
"type": "TemporalRS",
54+
"calendar": "Gregorian"
55+
}
56+
}],
57+
"coverages": [
58+
{
59+
"type" : "Coverage",
60+
"domain" : {
61+
"type": "Domain",
62+
"axes": {
63+
"x": { "values": [-10.1] },
64+
"y": { "values": [-40.2] },
65+
"z": { "values": [ 5, 8, 14 ] },
66+
"t": { "values": ["2013-01-13T11:12:20Z"] }
67+
}
68+
},
69+
"ranges" : {
70+
"PSAL" : {
71+
"type" : "NdArray",
72+
"dataType": "float",
73+
"shape": [3],
74+
"axisNames": ["z"],
75+
"values" : [ 43.7, 43.8, 43.9 ]
76+
}
77+
}
78+
}, {
79+
"type" : "Coverage",
80+
"domain" : {
81+
"type": "Domain",
82+
"axes": {
83+
"x": { "values": [-11.1] },
84+
"y": { "values": [-45.2] },
85+
"z": { "values": [ 4, 7, 9 ] },
86+
"t": { "values": ["2013-01-13T12:12:20Z"] }
87+
}
88+
},
89+
"ranges" : {
90+
"PSAL" : {
91+
"type" : "NdArray",
92+
"dataType": "float",
93+
"shape": [3],
94+
"axisNames": ["z"],
95+
"values" : [ 42.7, 41.8, 40.9 ]
96+
}
97+
}
98+
}]
99+
}
100+
```
101+
102+
For more details, see the [Collection](https://covjson.org/spec/#coverage-collection-objects) section of the specification.

parameter-sea-ice-area-fraction.md renamed to parameter-fractional-quantities.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
# Sea Ice Area Fraction
1+
# Fractional Quantities
22

3-
In this example we will see how a fraction can be represented in CovJSON. For that we use the sea ice area fraction.
3+
In this example we will see how a fractional quantity can be represented in CovJSON. For that we use the sea ice area fraction.
44

55
Fractions in CovJSON are stored as a decimal number which is typically between 0 and 1. Percentages are fractions comparing a number to 100, which means they simply have a unit of `1/100`, which is often symbolized with the percentage sign `%`. Depending on how data values are stored, those two cases have to be distinguished.
66

parameter-argo-quality-flags.md renamed to parameter-quality-flags.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{% from "macros.md" import playgroundLink %}
22

3-
# Argo Quality Flags
3+
# Quality Flags
44

55
Quality flags in CovJSON are represented with a categorical parameter. In this example we use the [Argo quality flags](http://mmisw.org/ont/argo/qualityFlag):
66

0 commit comments

Comments
 (0)