Skip to content

Commit

Permalink
Improved documentation for aggregate_polygon. (#29)
Browse files Browse the repository at this point in the history
  • Loading branch information
m-mohr committed Feb 14, 2019
1 parent b2dc570 commit 8803bd8
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion aggregate_polygon.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"id": "aggregate_polygon",
"summary": "Compute zonal statistics for polygons",
"description": "Aggregates zonal statistics for one or multiple polygons over the spatial dimensions.\n\nThe number of total and valid pixels is returned together with the calculated values.",
"description": "Aggregates zonal statistics for one or multiple polygons over the spatial dimensions.\n\nThe data cube must have been reduced to only contain two raster dimensions and a third dimension the values are aggregated from, for example a single band. Otherwise this process fails with the `TooManyDimensions` error.\n\nThe number of total and valid pixels is returned together with the calculated values.",
"categories": [
"cubes",
"aggregate"
Expand Down Expand Up @@ -73,6 +73,11 @@
]
}
},
"exceptions": {
"TooManyDimensions": {
"message": "The dimensions need to be reduced to three for 'aggregate_polygon'."
}
},
"links": [
{
"href": "https://github.com/Open-EO/openeo-processes/issues/2",
Expand Down

0 comments on commit 8803bd8

Please sign in to comment.