From 130655d3273d38dbb1b3247d8b3e7a6cd3838ed2 Mon Sep 17 00:00:00 2001 From: Paul Ramsey Date: Mon, 6 Nov 2017 21:51:27 +0000 Subject: [PATCH] Documentation tweaks for st_voronoi from Anne Blankert git-svn-id: http://svn.osgeo.org/postgis/trunk@16093 b70326c6-7e19-0410-871a-916f4a2858ee --- doc/reference_processing.xml | 47 ++++++++++++++++++------------------ 1 file changed, 23 insertions(+), 24 deletions(-) diff --git a/doc/reference_processing.xml b/doc/reference_processing.xml index 4216c12f5..f1ad77001 100644 --- a/doc/reference_processing.xml +++ b/doc/reference_processing.xml @@ -3709,24 +3709,22 @@ MULTILINESTRING((3 4,4 5),(1 2,3 4)) Description - ST_VoronoiLines computes a two-dimensional Voronoi diagram from the vertices of - the supplied geometry and returns the boundaries between cells in that diagram as a MultiLineString. - - + the supplied geometry and returns the boundaries between cells in that diagram as a MultiLineString. + Returns null if input geometry is null. Returns an empty geometry collection if the input geometry contains only one vertex. Returns an empty geometry collection if the extend_to envelope has zero area. + Optional parameters: - - - 'tolerance' : The distance within which vertices will be considered equivalent. Robustness of the algorithm can be improved by supplying a nonzero tolerance distance. (default = 0.0) - - - 'extend_to' : If a geometry is supplied as the "extend_to" parameter, the diagram will be extended to cover the - envelope of the "extend_to" geometry, unless that envelope is smaller than the default envelope. - (default = NULL) - - + + + 'tolerance' : The distance within which vertices will be considered equivalent. Robustness of the algorithm can be improved by supplying a nonzero tolerance distance. (default = 0.0) + + + 'extend_to' : If a geometry is supplied as the "extend_to" parameter, the diagram will be extended to cover the envelope of the "extend_to" geometry, unless + that envelope is smaller than the default envelope (default = NULL, default envelope is boundingbox of input geometry extended by about 50% in each direction). + + Availability: 2.3.0 - requires GEOS >= 3.5.0. @@ -3806,20 +3804,21 @@ MULTILINESTRING((135.555555555556 270,36.8181818181818 92.2727272727273),(36.818 ST_VoronoiPolygons computes a two-dimensional Voronoi diagram from the vertices of the supplied geometry. The result is a GeometryCollection of Polygons that covers an envelope larger than the extent of the input vertices. + Returns null if input geometry is null. Returns an empty geometry collection if the input geometry contains only one vertex. Returns an empty geometry collection if the extend_to envelope has zero area. Optional parameters: - - - 'tolerance' : The distance within which vertices will be considered equivalent. Robustness of the algorithm can be improved by supplying a nonzero tolerance distance. (default = 0.0) - - - 'extend_to' : If a geometry is supplied as the "extend_to" parameter, the diagram will be extended to cover the - envelope of the "extend_to" geometry, unless that envelope is smaller than the default envelope. - (default = NULL) - - + + + 'tolerance' : The distance within which vertices will be considered equivalent. Robustness of the algorithm can be improved by supplying a nonzero tolerance distance. (default = 0.0) + + + 'extend_to' : If a geometry is supplied as the "extend_to" parameter, the diagram will be extended to cover the envelope of the "extend_to" geometry, unless + that envelope is smaller than the default envelope (default = NULL, default envelope is boundingbox of input geometry extended by about 50% in each direction). + + + Availability: 2.3.0 - requires GEOS >= 3.5.0. -- 2.40.0