ST_SquareBins

ST_SquareBins takes a geometry column and a numeric bin size and returns an array column. The result array contains square bins that cover the spatial extent of each record in the input column. The specified bin size determines the height of each bin and is in the same units as the input geometry. You can optionally specify a numeric value for padding, which conceptually applies a buffer of the specified distance to the input geometry before creating the square bins.

Function	Syntax
Python	`square_bins(geometry, bin_size, padding=0.0)`
SQL	`ST_SquareBins(geometry, bin_size, padding)`

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

Examples

Python

SQL

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

data = [
    (Polygon([[[2,2],[2,12],[12,12],[12,2]]]),),
    (Polygon([[[20,0],[30,20],[40,0]]]),),
    (Polygon([[[20,30],[25,35],[30,30]]]),)
]

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

bins = df.select(ST.square_bins("polygon", 5, 2).alias("bins"))

bin_geometries = bins.select(F.explode("bins").alias("bin")).select(ST.bin_geometry("bin"))

ax = df.st.plot("polygon", facecolor="none", edgecolor="red")
bin_geometries.st.plot(ax=ax, facecolor="none", edgecolor="blue")

Plotting example for ST_SquareBins — Plotted result for ST_SquareBins.

Version table

Release	Notes
1.0.0	Function introduced

ST_SquareBins

Examples

Version table

Related topics