GeoSeries.
contains
Returns a Series of dtype('bool') with value True for each aligned geometry that contains other.
Series
dtype('bool')
True
An object is said to contain other if its interior contains the boundary and interior of the other object and their boundaries do not touch at all.
This is the inverse of within() in the sense that the expression a.contains(b) == b.within(a) always evaluates to True.
within()
a.contains(b) == b.within(a)
The operation works on a 1-to-1 row-wise manner:
The GeoSeries (elementwise) or geometric object to test if is contained.
If True, automatically aligns GeoSeries based on their indices. If False, the order of elements is preserved.
See also
GeoSeries.within
Notes
This method works in a row-wise manner. It does not check if an element of one GeoSeries contains any element of the other one.
Examples
>>> from shapely.geometry import Polygon, LineString, Point >>> s = geopandas.GeoSeries( ... [ ... Polygon([(0, 0), (1, 1), (0, 1)]), ... LineString([(0, 0), (0, 2)]), ... LineString([(0, 0), (0, 1)]), ... Point(0, 1), ... ], ... index=range(0, 4), ... ) >>> s2 = geopandas.GeoSeries( ... [ ... Polygon([(0, 0), (2, 2), (0, 2)]), ... Polygon([(0, 0), (1, 2), (0, 2)]), ... LineString([(0, 0), (0, 2)]), ... Point(0, 1), ... ], ... index=range(1, 5), ... )
>>> s 0 POLYGON ((0.00000 0.00000, 1.00000 1.00000, 0.... 1 LINESTRING (0.00000 0.00000, 0.00000 2.00000) 2 LINESTRING (0.00000 0.00000, 0.00000 1.00000) 3 POINT (0.00000 1.00000) dtype: geometry
>>> s2 1 POLYGON ((0.00000 0.00000, 2.00000 2.00000, 0.... 2 POLYGON ((0.00000 0.00000, 1.00000 2.00000, 0.... 3 LINESTRING (0.00000 0.00000, 0.00000 2.00000) 4 POINT (0.00000 1.00000) dtype: geometry
We can check if each geometry of GeoSeries contains a single geometry:
>>> point = Point(0, 1) >>> s.contains(point) 0 False 1 True 2 False 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 using align=False:
align=True
align=False
>>> s2.contains(s, align=True) 0 False 1 False 2 False 3 True 4 False dtype: bool
>>> s2.contains(s, align=False) 1 True 2 False 3 True 4 True dtype: bool