ST_Centroid

ST_Centroid takes a geometry column and returns a point column that represents the centroid of each input geometry. The result point is not guaranteed to be on the surface of the geometry.

Function	Syntax
Python	`centroid(geometry)`
SQL	`ST_Centroid(geometry)`

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

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

data = [
    ("POINT (10 30)",),
    ("MULTIPOINT (0 0, 5 5, 0 5)", ),
    ("LINESTRING (15 15, 10 15, 12 2)", ),
    ("POLYGON ((20 30, 18 28, 22 35, 40 20))", )
]

df = spark.createDataFrame(data, ["wkt"])\
          .select(ST.geom_from_text("wkt").alias("geometry"))

df = df.withColumn("centroid",ST.centroid("geometry"))

ax = df.st.plot("geometry", facecolor="none", edgecolor="red")
df.st.plot("centroid", ax=ax, facecolor="none", edgecolor="blue")

Plotting example for ST_Centroid — Plotted result for ST_Centroid.

Version table

Release	Notes
1.0.0	Function introduced

ST_Centroid

Examples

Version table

Related topics