gemgis.vector.subtract_geom_objects

gemgis.vector.subtract_geom_objects(geom_object1: shapely.geometry.base.BaseGeometry, geom_object2: shapely.geometry.base.BaseGeometry) → shapely.geometry.base.BaseGeometry

Subtracting Shapely geometry objects from each other and returning the left over object

Parameters

• geom_object1 (shapely.geometry.base.BaseGeometry) – Shapely object from which other object will be subtracted, e.g. geom_object1 = Polygon([[0, 0], [10, 0], [10, 10], [0, 10], [0, 0]])

• geom_object2 (shapely.geometry.base.BaseGeometry) – Shapely object which will be subtracted from other object e.g. geom_object2 = Polygon([[5, 0], [15, 0], [15, 10], [5, 10], [5, 0]])

Returns

result – Shapely object from which the second object was subtracted

Return type

shapely.geometry.base.BaseGeometry

New in version 1.0.x.

Example

>>> # Loading Libraries and creating Polygon
>>> import gemgis as gg
>>> from shapely.geometry import Polygon
>>> polygon1 = Polygon([[0, 0], [10, 0], [10, 10], [0, 10], [0, 0]])
>>> polygon1.wkt
'POLYGON ((0 0, 10 0, 10 10, 0 10, 0 0))'

>>> # Creating second Polygon
>>> polygon2 = Polygon([[5, 0], [15, 0], [15, 10], [5, 10], [5, 0]])
>>> polygon2.wkt
'POLYGON ((5 0, 15 0, 15 10, 5 10, 5 0))'

>>> # Subtracting geometries from each other
>>> difference = gg.vector.subtract_geom_objects(geom_object1=polygon1, geom_object2=polygon2)
>>> difference.wkt
'POLYGON ((5 0, 0 0, 0 10, 5 10, 5 0))'