Improved docs for GEOSGeometry.simplify()

This commit is contained in:
Tom Dyson 2014-07-25 01:24:52 +01:00 committed by Tim Graham
parent 6508db2ff9
commit aa8bc7fa7d
1 changed files with 8 additions and 9 deletions

View File

@ -440,17 +440,16 @@ topological relationship between this geometry and the other.
.. method:: GEOSGeometry.simplify(tolerance=0.0, preserve_topology=False) .. method:: GEOSGeometry.simplify(tolerance=0.0, preserve_topology=False)
Returns a new :class:`GEOSGeometry`, simplified using the Douglas-Peucker Returns a new :class:`GEOSGeometry`, simplified to the specified tolerance
algorithm to the specified tolerance. A higher tolerance value implies using the Douglas-Peucker algorithm. A higher tolerance value implies
less points in the output. If no tolerance is tolerance provided, fewer points in the output. If no tolerance is provided, it defaults to 0.
it defaults to 0.
By default, this function does not preserve topology - e.g., By default, this function does not preserve topology. For example,
:class:`Polygon` objects can be split, collapsed into lines or disappear. :class:`Polygon` objects can be split, be collapsed into lines, or disappear.
:class:`Polygon` holes can be created or disappear, and lines can cross. :class:`Polygon` holes can be created or disappear, and lines may cross.
By specifying ``preserve_topology=True``, the result will have the same By specifying ``preserve_topology=True``, the result will have the same
dimension and number of components as the input, however, this is dimension and number of components as the input; this is significantly
significantly slower. slower, however.
.. method:: GEOSGeometry.sym_difference(other) .. method:: GEOSGeometry.sym_difference(other)