-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathspec-properties.qmd
More file actions
407 lines (296 loc) · 10.4 KB
/
spec-properties.qmd
File metadata and controls
407 lines (296 loc) · 10.4 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
---
title: "Property Reference"
format: html
---
GeoCroissant introduces a set of specialised metadata properties that extend the core Croissant vocabulary with geospatial concepts. This page provides a full technical reference for each property, including its domain, range, cardinality, and usage examples.
## Namespaces
The GeoCroissant vocabulary lives under its own namespace:
```
http://mlcommons.org/croissant/geo/
```
This is typically abbreviated using the prefix `geocr`. The table below lists all namespaces used in GeoCroissant metadata.
| Prefix | IRI | Description |
|---|---|---|
| `sc` | `http://schema.org/` | The schema.org namespace |
| `cr` | `http://mlcommons.org/croissant/` | MLCommons Croissant base namespace |
| `geocr` | `http://mlcommons.org/croissant/geo/` | GeoCroissant extension namespace |
| `dct` | `http://purl.org/dc/terms/` | Dublin Core Terms |
The specification itself is versioned via its URI: `http://mlcommons.org/croissant/geo/1.0`. Note that the vocabulary namespace is *not* versioned — property IRIs remain stable across versions of the specification.
---
## Spatial Metadata
### `geocr:coordinateReferenceSystem`
The coordinate reference system (CRS) or projection used to interpret spatial data. This is essential for any dataset whose records need to be correctly aligned and compared across tools and platforms.
| | |
|---|---|
| **Type** | `sc:Text` |
| **Domain** | `sc:Dataset` |
| **Cardinality** | ONE |
```json
{
"@type": "Dataset",
"geocr:coordinateReferenceSystem": "EPSG:4326"
}
```
---
### `geocr:spatialResolution`
The nominal ground sampling distance — how much real-world area one pixel covers. Can be set at dataset level for uniform imagery, or at record level when resolution varies across records (e.g., Harmonized Landsat/Sentinel-2).
| | |
|---|---|
| **Type** | `sc:Text` or `sc:QuantitativeValue` |
| **Domain** | `sc:Dataset`, `cr:RecordSet` |
| **Cardinality** | ONE |
**Dataset level:**
```json
{
"geocr:spatialResolution": { "@type": "QuantitativeValue", "value": 30, "unitText": "m" }
}
```
**Record level (when resolution varies):**
```json
{
"recordSet": [{
"@type": "cr:RecordSet",
"field": [{ "@type": "cr:Field", "name": "spatialResolution", "dataType": "sc:Text" }],
"data": [
{ "spatialResolution": "10m" },
{ "spatialResolution": "30m" }
]
}]
}
```
---
### `geocr:spatialIndex`
Precomputed spatial index tokens (e.g., H3 cells, DGGS identifiers, geohashes) that support fast coarse spatial filtering before running exact geometry operations. Particularly useful for large catalogs.
| | |
|---|---|
| **Type** | `sc:Text` |
| **Domain** | `sc:Dataset`, `cr:RecordSet` |
| **Cardinality** | MANY |
```json
{
"geocr:spatialIndex": ["h3:8a2a1072b59fff", "h3:8a2a1072b5bfff"]
}
```
---
## Spectral & Band Metadata
### `geocr:bandConfiguration`
Describes how bands are organised within a raster dataset — how many there are, in what order, and what they represent. Can be set at dataset or field level.
| | |
|---|---|
| **Type** | `geocr:BandConfiguration` |
| **Domain** | `sc:Dataset`, `cr:Field` |
| **Cardinality** | ONE |
```json
{
"geocr:bandConfiguration": {
"@type": "geocr:BandConfiguration",
"geocr:totalBands": 6,
"geocr:bandNameList": ["Blue", "Green", "Red", "NIR", "SW1", "SW2"]
}
}
```
---
### `geocr:totalBands`
The total number of bands in the raster asset.
| | |
|---|---|
| **Type** | `sc:Integer` |
| **Domain** | `geocr:BandConfiguration` |
| **Cardinality** | ONE |
```json
"geocr:totalBands": 6
```
---
### `geocr:bandNameList`
An ordered list of band names corresponding to the raster band stack.
| | |
|---|---|
| **Type** | `sc:Text` |
| **Domain** | `geocr:BandConfiguration` |
| **Cardinality** | MANY |
```json
"geocr:bandNameList": ["Blue", "Green", "Red", "NIR", "SW1", "SW2"]
```
---
### `geocr:spectralBandMetadata`
Per-band spectral descriptors — center wavelength, bandwidth, and similar physical quantities. Use this when downstream systems or models need band physics beyond simple names.
| | |
|---|---|
| **Type** | `geocr:SpectralBand` |
| **Domain** | `sc:Dataset`, `cr:Field` |
| **Cardinality** | MANY |
```json
{
"geocr:spectralBandMetadata": [
{
"@type": "geocr:SpectralBand",
"name": "Blue",
"geocr:centerWavelength": { "@type": "QuantitativeValue", "value": 490, "unitText": "nm" },
"geocr:bandwidth": { "@type": "QuantitativeValue", "value": 98, "unitText": "nm" }
},
{
"@type": "geocr:SpectralBand",
"name": "NIR",
"geocr:centerWavelength": { "@type": "QuantitativeValue", "value": 865, "unitText": "nm" }
}
]
}
```
---
### `geocr:centerWavelength`
The center wavelength for a spectral band.
| | |
|---|---|
| **Type** | `sc:QuantitativeValue` |
| **Domain** | `geocr:SpectralBand` |
| **Cardinality** | ONE |
```json
"geocr:centerWavelength": { "@type": "QuantitativeValue", "value": 490, "unitText": "nm" }
```
---
### `geocr:bandwidth`
The spectral bandwidth (full-width at half-maximum) for a band entry.
| | |
|---|---|
| **Type** | `sc:QuantitativeValue` |
| **Domain** | `geocr:SpectralBand` |
| **Cardinality** | ZERO or ONE |
```json
"geocr:bandwidth": { "@type": "QuantitativeValue", "value": 98, "unitText": "nm" }
```
---
## Temporal Metadata
### `geocr:temporalResolution`
The temporal cadence of the collection — how frequently observations are taken. Can be set at dataset or record level when cadence varies.
| | |
|---|---|
| **Type** | `sc:Text` or `sc:QuantitativeValue` |
| **Domain** | `sc:Dataset`, `cr:RecordSet` |
| **Cardinality** | ZERO or ONE |
```json
"geocr:temporalResolution": { "@type": "QuantitativeValue", "value": 1, "unitText": "month" }
```
---
### `geocr:timeSeriesIndex`
Identifies the field within a RecordSet that provides the temporal ordering key — typically a timestamp. This allows downstream systems to sort, slice, and batch time-series records reliably.
| | |
|---|---|
| **Type** | `sc:Text` |
| **Domain** | `cr:RecordSet` |
| **Cardinality** | ZERO or ONE |
```json
{
"@type": "cr:RecordSet",
"geocr:timeSeriesIndex": { "@id": "timeseries_recordset/timestamp" },
"field": [
{ "@type": "cr:Field", "@id": "timeseries_recordset/timestamp", "name": "timestamp", "dataType": "sc:DateTime" }
]
}
```
---
## Responsible GeoAI
### `geocr:spatialBias`
A plain-language description of any known geographic representativeness limitations that could affect model generalisation — for example, if coverage is concentrated in one region or continent.
| | |
|---|---|
| **Type** | `sc:Text` |
| **Domain** | `sc:Dataset` |
| **Cardinality** | ZERO or ONE |
```json
"geocr:spatialBias": "Coverage is concentrated over the contiguous United States; high-latitude regions and other global biomes are under-represented."
```
---
### `geocr:samplingStrategy`
Describes how training samples were constructed — including windowing strategies, filtering criteria, and any design choices that influence what the model learns.
| | |
|---|---|
| **Type** | `sc:Text` |
| **Domain** | `sc:Dataset` |
| **Cardinality** | ZERO or ONE |
```json
"geocr:samplingStrategy": "512×512 chips centred on burn polygons; cloudy scenes removed."
```
---
## Programmatic Access
### `geocr:recordEndpoint`
A URL pointing to a service where the dataset's metadata records can be queried and retrieved programmatically. This is useful when GeoCroissant metadata is served dynamically from a catalog or registry (e.g., an OGC API – Records endpoint).
Clients can use this endpoint to list records, page through results, and apply spatial or temporal filters — for example by appending `?bbox=-125,24,-66,49` or `?datetime=2018-01-01/2021-12-31`.
| | |
|---|---|
| **Type** | `sc:URL` |
| **Domain** | `sc:Dataset` |
| **Cardinality** | ZERO or ONE |
```json
"geocr:recordEndpoint": "https://example.org/ogcapi/records"
```
---
## Space Weather Metadata
These properties support heliophysics and space weather datasets, where observations are described using wavelength channels and instrument characterisation rather than geographic coordinates.
### `geocr:multiWavelengthConfiguration`
A composite wrapper describing the wavelength channels used in a space weather or heliophysics dataset, designed to simplify authoring and support mapping to SPASE constructs.
| | |
|---|---|
| **Type** | `geocr:MultiWavelengthConfiguration` |
| **Domain** | `sc:Dataset` |
| **Cardinality** | ZERO or ONE |
```json
{
"geocr:multiWavelengthConfiguration": {
"@type": "geocr:MultiWavelengthConfiguration",
"geocr:channelList": ["171Å", "193Å"]
}
}
```
---
### `geocr:solarInstrumentCharacteristics`
A composite wrapper for solar instrument characterisation — observatory and instrument identifiers — to support mapping to SPASE.
| | |
|---|---|
| **Type** | `geocr:SolarInstrumentCharacteristics` |
| **Domain** | `sc:Dataset` |
| **Cardinality** | ZERO or ONE |
```json
{
"geocr:solarInstrumentCharacteristics": {
"@type": "geocr:SolarInstrumentCharacteristics",
"geocr:observatory": "SDO",
"geocr:instrument": "AIA"
}
}
```
---
### `geocr:observatory`
Name or identifier of the observatory or platform.
```json
"geocr:observatory": "SDO"
```
### `geocr:instrument`
Name or identifier of the instrument producing the measurement.
```json
"geocr:instrument": "AIA"
```
### `geocr:channelList`
The wavelength channels used in a multi-wavelength dataset.
```json
"geocr:channelList": ["171Å", "193Å"]
```
---
## Adding Custom Properties
If a metadata attribute is already defined in an established vocabulary (GeoSPARQL, SPASE, Dublin Core), reuse that term directly by declaring the appropriate prefix in `@context`.
If no suitable external term exists, express the attribute using `sc:additionalProperty` with `sc:PropertyValue`:
```json
{
"additionalProperty": [
{
"@type": "PropertyValue",
"name": "cloudCoverMedian",
"value": { "@type": "QuantitativeValue", "value": 12.3, "unitText": "%" }
},
{
"@type": "PropertyValue",
"name": "tilingScheme",
"value": "MGRS"
}
]
}
```