Skip to content

Commit 3c6f11a

Browse files
committed
Fine-tune docs a bit on passing a GeoJSON URL to aggregate_spatial, ...
1 parent 4b80d1b commit 3c6f11a

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

openeo/rest/datacube.py

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -758,7 +758,8 @@ def aggregate_spatial(
758758
Aggregates statistics for one or more geometries (e.g. zonal statistics for polygons)
759759
over the spatial dimensions.
760760
761-
:param geometries: shapely geometry, GeoJSON dictionary or path to GeoJSON file
761+
:param geometries: a shapely geometry, a GeoJSON-style dictionary,
762+
a public GeoJSON URL, or a path (that is valid for the back-end) to a GeoJSON file.
762763
:param reducer: a callback function that creates a process graph, see :ref:`callbackfunctions`
763764
:param target_dimension: The new dimension name to be used for storing the results.
764765
:param crs: The spatial reference system of the provided polygon.
@@ -922,9 +923,8 @@ def chunk_polygon(
922923
923924
.. warning:: experimental process: not generally supported, API subject to change.
924925
925-
:param chunks: Polygon(s), provided as a :class:`shapely.geometry.GeometryCollection`
926-
, a :class:`shapely.geometry.MultiPolygon`, a filename pointing to a valid vector file
927-
or a :class:`shapely.geometry.Polygon`.
926+
:param chunks: Polygons, provided as a shapely geometry, a GeoJSON-style dictionary,
927+
a public GeoJSON URL, or a path (that is valid for the back-end) to a GeoJSON file.
928928
:param process: "child callback" function, see :ref:`callbackfunctions`
929929
:param mask_value: The value used for cells outside the polygon.
930930
This provides a distinction between NoData cells within the polygon (due to e.g. clouds)
@@ -1345,7 +1345,8 @@ def mask_polygon(
13451345
The pixel values are replaced with the value specified for `replacement`,
13461346
which defaults to `no data`.
13471347
1348-
:param mask: A polygon, provided as a :class:`shapely.geometry.Polygon` or :class:`shapely.geometry.MultiPolygon`, or a filename pointing to a valid vector file
1348+
:param mask: The geometry to mask with: a shapely geometry, a GeoJSON-style dictionary,
1349+
a public GeoJSON URL, or a path (that is valid for the back-end) to a GeoJSON file.
13491350
:param srs: The spatial reference system of the provided polygon.
13501351
By default longitude-latitude (EPSG:4326) is assumed.
13511352

0 commit comments

Comments
 (0)