GeoSeries.relate_pattern

Returns a Series of dtype('bool') with value True if the DE-9IM relationship between each geometry and other matches the specified pattern. The operation works on a 1-to-1 row-wise manner.

Signature

relate_pattern(other, pattern, align=None) -> pspd.Series

Parameters

GeoSeries or geometric object

required

The GeoSeries (elementwise) or geometric object to relate to.

str

required

The DE-9IM pattern to match. A 9-character string where each character is one of: ‘T’ (matches any non-empty intersection), ‘F’ (matches empty intersection), ’*’ (matches anything), ‘0’, ‘1’, ‘2’ (matches specific dimensions).

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.

See also

GeoSeries.relate
GeoSeries.contains
GeoSeries.intersects

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(3, 3),
...     ]
... )

>>> s.relate_pattern(s2, "T*F**FFF*")
0     True
1    False
dtype: bool

​Signature

​Parameters

​Returns

​Examples

Signature

Parameters

Returns

Examples