forked from Open-EO/openeo-processes
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mask.json
60 lines (60 loc) · 2.68 KB
/
mask.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
{
"id": "mask",
"summary": "Apply a mask",
"description": "Applies a mask to a raster data cube. A mask can either be specified as:\n\n* **Raster data cube** for which parallel pixels among `data` and `mask` are compared and those pixels in `data` are replaced, which are non-zero (for numbers) or `true` (for boolean values) in `mask`.\n* **GeoJSON or vector data cube** containing one or more polygons. All pixels for which the point at the pixel center intersects with the corresponding polygon (as defined in the Simple Features standard by the OGC) are replaced.\n\nThe pixel values are replaced with the value specified for `replacement`, which defaults to `null` (no data). No data values will be left untouched by the masking operation.",
"categories": [
"masks"
],
"parameter_order": ["data", "mask", "replacement"],
"parameters": {
"data": {
"description": "A raster data cube.",
"schema": {
"type": "object",
"format": "raster-cube"
},
"required": true
},
"mask": {
"description": "Either a raster data cube, a GeoJSON object or a vector data cube.\n\nFor **raster data cubes**, both data cubes must be compatible so that every pixel in `data` has a parallel element in `mask`.\n\nFor **GeoJSON** the provided types can be one of the following:\n\n* A `Polygon` geometry,\n* a `GeometryCollection` containing Polygons,\n* a `Feature` with a `Polygon` geometry or\n* a `FeatureCollection` containing `Feature`s with a `Polygon` geometry.",
"schema": {
"anyOf": [
{
"type": "object",
"format": "geojson"
},
{
"type": "object",
"format": "vector-cube"
},
{
"type": "object",
"format": "raster-cube"
}
]
},
"required": true
},
"replacement": {
"description": "The value used to replace non-zero and `true` values with.",
"schema": {
"type": ["number","boolean","string","null"],
"default": null
}
}
},
"returns": {
"description": "The masked raster data cube.",
"schema": {
"type": "object",
"format": "raster-cube"
}
},
"links": [
{
"href": "http://www.opengeospatial.org/standards/sfa",
"rel": "about",
"title": "Simple Features standard by the OGC"
}
]
}