geopandas.GeoSeries.covered_by¶

GeoSeries.
covered_by
(other, align=True)¶ Returns a
Series
ofdtype('bool')
with valueTrue
for each aligned geometry that is entirely covered by other.An object A is said to cover another object B if no points of B lie in the exterior of A.
The operation works on a 1to1 rowwise manner:
See https://linearthinking.blogspot.com/2007/06/subtletiesofogccoversspatial.html for reference.
 Parameters
 otherGeoseries or geometric object
The Geoseries (elementwise) or geometric object to check is being covered.
 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
Notes
This method works in a rowwise manner. It does not check if an element of one GeoSeries is
covered_by
any element of the other one.Examples
>>> from shapely.geometry import Polygon, LineString, Point >>> s = geopandas.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), ... ], ... ) >>> s2 = geopandas.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), ... ], ... index=range(1, 5), ... )
>>> s 0 POLYGON ((0.50000 0.50000, 1.50000 0.50000, 1.... 1 POLYGON ((0.00000 0.00000, 2.00000 0.00000, 2.... 2 LINESTRING (1.00000 1.00000, 1.50000 1.50000) 3 POINT (0.00000 0.00000) dtype: geometry
>>> s2 1 POLYGON ((0.00000 0.00000, 2.00000 0.00000, 2.... 2 POLYGON ((0.00000 0.00000, 2.00000 2.00000, 0.... 3 LINESTRING (0.00000 0.00000, 2.00000 2.00000) 4 POINT (0.00000 0.00000) dtype: geometry
We can check if each geometry of GeoSeries is covered by a single geometry:
>>> poly = Polygon([(0, 0), (2, 0), (2, 2), (0, 2)]) >>> s.covered_by(poly) 0 True 1 True 2 True 3 True 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 usingalign=False
:>>> s.covered_by(s2, align=True) 0 False 1 True 2 True 3 True 4 False dtype: bool
>>> s.covered_by(s2, align=False) 0 True 1 False 2 True 3 True dtype: bool