GeoDataFrame.covers

Returns a Series of dtype('bool') with value True for each aligned geometry that is entirely covering other. An object A is said to cover another object B if no points of B lie in the exterior of A. If either object is empty, this operation returns False. Note: Sedona’s implementation instead returns False for identical geometries. Sedona’s behavior may also differ from Geopandas for GeometryCollections. The operation works on a 1-to-1 row-wise manner. See https://lin-ear-th-inking.blogspot.com/2007/06/subtleties-of-ogc-covers-spatial.html for reference.

Signature

covers(other, align=None)

Parameters

Geoseries or geometric object

required

The Geoseries (elementwise) or geometric object to check is being covered.

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

Series(bool)

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

See also

GeoSeries.covered_by
GeoSeries.overlaps

Examples

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

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

>>> s2
1    POLYGON ((0.5 0.5, 1.5 0.5, 1.5 1.5, 0.5 1.5, ...
2                  POLYGON ((0 0, 2 0, 2 2, 0 2, 0 0))
3                            LINESTRING (1 1, 1.5 1.5)
4                                          POINT (0 0)
dtype: geometry

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

>>> poly = Polygon([(0, 0), (2, 0), (2, 2), (0, 2)])
>>> s.covers(poly)
0     True
1    False
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.covers(s2, align=True)
  False
  False
  False
  False
  False
dtype: bool

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

​Signature

​Parameters

​Returns

​Examples

Signature

Parameters

Returns

Examples