forked from Open-EO/openeo-processes
-
Notifications
You must be signed in to change notification settings - Fork 0
/
filter_temporal.json
84 lines (84 loc) · 4.26 KB
/
filter_temporal.json
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
{
"id": "filter_temporal",
"summary": "Temporal filter for a date and/or time intervals",
"description": "Limits the data cube to the specified interval of dates and/or times.\n\nMore precisely, the filter checks whether the temporal dimension value is greater than or equal to the lower boundary (start date/time) and the temporal dimension value is less than the value of the upper boundary (end date/time). This corresponds to a left-closed interval, which contains the lower boundary but not the upper boundary.\n\nIf the dimension is set to `null` (it's the default value), the data cube is expected to only have one temporal dimension.",
"categories": [
"filter"
],
"parameter_order": ["data", "extent", "dimension"],
"parameters": {
"data": {
"description": "A data cube.",
"schema": {
"type": "object",
"format": "raster-cube"
},
"required": true
},
"extent": {
"description": "Left-closed temporal interval, i.e. an array with exactly two elements:\n\n1. The first element is the start of the date and/or time interval. The specified instance in time is **included** in the interval.\n2. The second element is the end of the date and/or time interval. The specified instance in time is **excluded** from the interval.\n\nThe specified temporal strings follow [RFC 3339](https://tools.ietf.org/html/rfc3339). Although [RFC 3339 prohibits the hour to be '24'](https://tools.ietf.org/html/rfc3339#section-5.7), **this process allows the value '24' for the hour** of an end time in order to make it possible that left-closed time intervals can fully cover the day.\n\nAlso supports open intervals by setting one of the boundaries to `null`, but never both.",
"schema": {
"type": "array",
"format": "temporal-interval",
"minItems": 2,
"maxItems": 2,
"items": {
"anyOf": [
{
"type": "string",
"format": "date-time"
},
{
"type": "string",
"format": "date"
},
{
"type": "string",
"format": "time"
},
{
"type": "null"
}
]
},
"examples": [
["2015-01-01", "2016-01-01"],
["12:00:00Z", "24:00:00Z"]
]
},
"required": true
},
"dimension": {
"description": "The temporal dimension to filter on. If the dimension is not set or is set to `null`, the data cube is expected to only have one temporal dimension. Fails with a `TooManyDimensions` error if it has more dimensions. Fails with a `DimensionNotAvailable` error if the specified dimension does not exist.\n\n**Note:** The default dimensions a data cube provides are described in the collection's metadata field `cube:dimensions`.",
"schema": {
"type": [
"string",
"null"
],
"default": null
}
}
},
"returns": {
"description": "A data cube restricted to the specified temporal extent. Therefore, the cardinality is potentially lower, but the resolution and the number of dimensions are the same as for the original data cube.",
"schema": {
"type": "object",
"format": "raster-cube"
}
},
"exceptions": {
"DimensionNotAvailable": {
"message": "A dimension with the specified name does not exist."
},
"TooManyDimensions": {
"message": "The number of temporal dimensions must be reduced to one for 'filter_temporal'."
}
},
"links": [
{
"rel": "about",
"href": "https://open-eo.github.io/openeo-api/processes/#openeo-specific-formats",
"title": "Information about the supported temporal formats."
}
]
}