geopandas.GeoSeries.overlaps

GeoSeries.overlaps(other, align=True)

Returns True for all aligned geometries that overlap other, else False.

Geometries overlaps if they have more than one but not all points in common, have the same dimension, and the intersection of the interiors of the geometries has the same dimension as the geometries themselves.

The operation works on a 1-to-1 row-wise manner:

Parameters

otherGeoSeries or geometric object

The GeoSeries (elementwise) or geometric object to test if overlaps.

alignbool (default True)

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

Returns

Series (bool)

See also

GeoSeries.crosses

GeoSeries.intersects

Notes

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

Examples

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

>>> s
0    POLYGON ((0.00000 0.00000, 2.00000 2.00000, 0....
1    POLYGON ((0.00000 0.00000, 2.00000 2.00000, 0....
2        LINESTRING (0.00000 0.00000, 2.00000 2.00000)
3        MULTIPOINT (0.00000 0.00000, 0.00000 1.00000)
dtype: geometry

>>> s2
1    POLYGON ((0.00000 0.00000, 2.00000 0.00000, 0....
2        LINESTRING (0.00000 1.00000, 1.00000 1.00000)
3        LINESTRING (1.00000 1.00000, 3.00000 3.00000)
4                              POINT (0.00000 1.00000)
dtype: geometry

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

>>> polygon = Polygon([(0, 0), (1, 0), (1, 1), (0, 1)])
>>> s.overlaps(polygon)
0     True
1     True
2    False
3    False
dtype: bool

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.overlaps(s2)
0    False
1     True
2    False
3    False
4    False
dtype: bool

>>> s.overlaps(s2, align=False)
0     True
1    False
2     True
3    False
dtype: bool

geopandas.GeoSeries.intersects geopandas.GeoSeries.touches