GeoDataFrame.contains_properly

Returns a Series of dtype('bool') with value True for each aligned geometry that properly contains other. An object is said to properly contain other if the other object lies entirely within the interior of the object (no shared boundary points). The operation works on a 1-to-1 row-wise manner.

Signature

contains_properly(other, align=None)

Parameters

GeoSeries or geometric object

required

The GeoSeries (elementwise) or geometric object to test whether it is properly 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_properly any element of the other one.The difference from contains is that contains_properly returns False when the other geometry touches the boundary of the object.

See also

GeoSeries.contains
GeoSeries.within

Examples

>>> from sedona.spark.geopandas import GeoSeries
>>> from shapely.geometry import Point, Polygon
>>> s = GeoSeries(
...     [
...         Polygon([(0, 0), (2, 0), (2, 2), (0, 2)]),
...         Polygon([(0, 0), (2, 0), (2, 2), (0, 2)]),
...     ]
... )
>>> s2 = GeoSeries(
...     [
...         Point(1, 1),
...         Point(0, 0),
...     ]
... )

>>> s.contains_properly(s2)
0     True
1    False
dtype: bool

​Signature

​Parameters

​Returns

​Examples

Signature

Parameters

Returns

Examples