From 8803bd8fe0c9dbbde4d20188780f9915889fd961 Mon Sep 17 00:00:00 2001 From: Matthias Mohr Date: Thu, 14 Feb 2019 12:56:44 +0100 Subject: [PATCH] Improved documentation for aggregate_polygon. (#29) --- aggregate_polygon.json | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/aggregate_polygon.json b/aggregate_polygon.json index 432a561a..ee51caa5 100644 --- a/aggregate_polygon.json +++ b/aggregate_polygon.json @@ -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" @@ -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",