GeoDataFrame.difference

Returns a GeoSeries of the points in each aligned geometry that are not in other. The operation works on a 1-to-1 row-wise manner: Unlike Geopandas, Sedona does not support this operation for GeometryCollections.

Signature

difference(other, align=None)

Parameters

Geoseries or geometric object

required

The Geoseries (elementwise) or geometric object to find the difference to.

bool | None (default None)

default:"None"

If True, automatically aligns GeoSeries based on their indices. None defaults to True. If False, the order of elements is preserved.

Returns

GeoSeries

This method works in a row-wise manner. It does not check if an element of one GeoSeries is different from any element of the other one.

See also

GeoSeries.intersection

Examples

>>> from sedona.spark.geopandas import GeoSeries
>>> from shapely.geometry import Polygon, LineString, Point
>>> s = GeoSeries(
...     [
...         Polygon([(0, 0), (2, 2), (0, 2)]),
...         Polygon([(0, 0), (2, 2), (0, 2)]),
...         LineString([(0, 0), (2, 2)]),
...         LineString([(2, 0), (0, 2)]),
...         Point(0, 1),
...     ],
... )
>>> s2 = GeoSeries(
...     [
...         Polygon([(0, 0), (1, 1), (0, 1)]),
...         LineString([(1, 0), (1, 3)]),
...         LineString([(2, 0), (0, 2)]),
...         Point(1, 1),
...         Point(0, 1),
...     ],
...     index=range(1, 6),
... )

>>> s
  POLYGON ((0 0, 2 2, 0 2, 0 0))
  POLYGON ((0 0, 2 2, 0 2, 0 0))
           LINESTRING (0 0, 2 2)
           LINESTRING (2 0, 0 2)
                     POINT (0 1)
dtype: geometry

>>> s2
  POLYGON ((0 0, 1 1, 0 1, 0 0))
           LINESTRING (1 0, 1 3)
           LINESTRING (2 0, 0 2)
                     POINT (1 1)
                     POINT (0 1)
dtype: geometry

We can check if each geometry of GeoSeries contains a single geometry:

>>> point = Point(0, 1)
>>> s2.difference(point)
1    POLYGON ((0 0, 1 1, 0 1, 0 0))
2             LINESTRING (1 0, 1 3)
3             LINESTRING (2 0, 0 2)
4                       POINT (1 1)
5           GEOMETRYCOLLECTION EMPTY
dtype: geometry

We can also check two GeoSeries against each other, row by row. The GeoSeries above have different indices. We can either align both GeoSeries based on index values and compare elements with the same index using align=True or ignore index and compare elements based on their matching order using align=False:

>>> s.difference(s2, align=True)
  POLYGON ((0 0, 2 2, 0 2, 0 0))
  POLYGON ((0 0, 2 2, 0 2, 0 0))
           LINESTRING (0 0, 2 2)
           LINESTRING (2 0, 0 2)
                     POINT (0 1)
                     POINT (0 1)
dtype: geometry

>>> s.difference(s2, align=False)
  POLYGON ((0 0, 2 2, 0 2, 0 0))
  POLYGON ((0 0, 2 2, 0 2, 0 0))
         GEOMETRYCOLLECTION EMPTY
           LINESTRING (2 0, 0 2)
         GEOMETRYCOLLECTION EMPTY
dtype: geometry

​Signature

​Parameters

​Returns

​Examples

Signature

Parameters

Returns

Examples