ST_Overlaps

ST_Overlaps takes two geometry columns and returns a boolean column. The function returns True if the first geometry and the second geometry spatially overlap; otherwise, it returns False. Two geometries overlap when their intersection is the same geometry type as either of the inputs but not equal to either of the inputs.

Function	Syntax
Python	`overlaps(geometry1, geometry2)`
SQL	`ST_Overlaps(geometry1, geometry2)`

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

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([[[0,0],[10,10],[20,0]]]), Linestring([[[10,10],[30,30]]])),
]

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

df.select(ST.overlaps("linestring1", "linestring2").alias("overlaps")).show()

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

Version table

Release	Notes
1.0.0	Function introduced

ST_Overlaps

Examples

Version table

Related topics