GeoDataFrame.contains

Returns a Series of dtype('bool') with value True for each aligned geometry that contains other. An object is said to contain other if at least one point of other lies in the interior and no points of other lie in the exterior of the object. (Therefore, any given polygon does not contain its own boundary - there is not any point that lies in the interior.) If either object is empty, this operation returns False. This is the inverse of within in the sense that the expression a.contains(b) == b.within(a) always evaluates to True. Note: Sedona’s implementation instead returns False for identical geometries. The operation works on a 1-to-1 row-wise manner.

Signature

contains(other, align=None)

Parameters

GeoSeries or geometric object

required

The GeoSeries (elementwise) or geometric object to test if it is contained.

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 contains any element of the other one.

See also

GeoSeries.contains_properly
GeoSeries.within

Examples

>>> from sedona.spark.geopandas import GeoSeries
>>> from shapely.geometry import Polygon, LineString, Point
>>> s = 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 = 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 0, 1 1, 0 1, 0 0))
1             LINESTRING (0 0, 0 2)
2             LINESTRING (0 0, 0 1)
3                       POINT (0 1)
dtype: geometry

>>> s2
1    POLYGON ((0 0, 2 2, 0 2, 0 0))
2    POLYGON ((0 0, 1 2, 0 2, 0 0))
3             LINESTRING (0 0, 0 2)
4                       POINT (0 1)
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:

>>> s2.contains(s, align=True)
  False
  False
  False
   True
  False
dtype: bool

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

​Signature

​Parameters

​Returns

​Examples

Signature

Parameters

Returns

Examples