ST_Relate

ST_Relate takes two geometry columns and a string and returns a boolean column. The function returns True if the first geometry and the second geometry satisfy the spatial relationship defined by the specified DE-9IM string code; otherwise, it returns False. The string code contains nine characters that represent the nine spatial relations of the dimensionally extended 9-intersection model (DE-9IM). The character values indicate the dimensionality of the relationship: 0 for points, 1 for linestrings, 2 for polygons, and 'F' to indicate an empty set.

Function	Syntax
Python	`relate(geometry1, geometry2, relation)`
SQL	`ST_Relate(geometry1, geometry2, relation)`

For more details, go to the GeoAnalytics Engine API reference for relate.

This function implements the OpenGIS Simple Features Implementation Specification for SQL 1.2.1.

Examples

Python

SQL

Use dark colors for code blocksCopy
from geoanalytics.sql import functions as ST, Linestring, Polygon

data = [
    (Linestring([[[10,10],[30,30]]]), Linestring([[[20,20],[40,40]]])),
    (Linestring([[[10,10],[30,30]]]), Linestring([[[10,10],[30,30]]])),
]

df = spark.createDataFrame(data, ["linestring1", "linestring2"])

df.select(ST.relate("linestring1", "linestring2", relation="1FFF0FFF2").alias("relate")).show()

Result
Use dark colors for code blocksCopy
+------+
|relate|
+------+
| false|
|  true|
+------+

Version table

Release	Notes
1.0.0	Function introduced

ST_Relate

Examples

Version table

Related topics