shapely.relate_pattern

relate_pattern(a, b, pattern, **kwargs)

Return True if the DE-9IM relationship code satisfies the pattern.

This function compares the DE-9IM code string for two geometries against a specified pattern. If the string matches the pattern then True is returned, otherwise False. The pattern specified can be an exact match (0, 1 or 2), a boolean match (uppercase T or F), or a wildcard (*). For example, the pattern for the within predicate is 'T*F**F***'.

Parameters:

a, bGeometry or array_like

Geometry or geometries to check.

patternstring

The pattern to match the DE-9IM relationship code against.

**kwargs

See NumPy ufunc docs for other keyword arguments.

Examples

>>> from shapely import Point, Polygon
>>> point = Point(0.5, 0.5)
>>> square = Polygon([(0, 0), (0, 1), (1, 1), (1, 0), (0, 0)])
>>> relate(point, square)
'0FFFFF212'
>>> relate_pattern(point, square, "T*F**F***")
True