st_makeenvelope

Platí pro: Databricks Runtime 18.2 a vyšší

Vrátí geometrii představující obálku zarovnanou osou 2D (minimální ohraničující rámeček) definovanou dvěma rohovými souřadnicemi (x1, y1) a (x2, y2).

Odpovídající funkci SQL Databricks vizte funkcest_makeenvelope.

Syntax

from pyspark.databricks.sql import functions as dbf

dbf.st_makeenvelope(x1=<x1>, y1=<y1>, x2=<x2>, y2=<y2>)

Parameters

Parameter	Typ	Description
x1	pyspark.sql.Column nebo float	Souřadnice X prvního rohu.
y1	pyspark.sql.Column nebo float	Souřadnice Y prvního rohu.
x2	pyspark.sql.Column nebo float	Souřadnice X druhého rohu.
y2	pyspark.sql.Column nebo float	Souřadnice Y druhého rohu.

Returns

pyspark.sql.Column: Sloupec hodnot geometrie představující 2D osu zarovnanou obálku dvou vstupních rohů. SRID vrácené geometrie je 0.

Vstupní rohy mohou být poskytovány v libovolném pořadí; výsledná obálka je stejná, jako kdyby byly rohy normalizovány do (xmin, ymin) a (xmax, ymax).

Typ vrácené geometrie závisí na vstupních rozích:

• Pokud se pole degeneruje na jeden bod (x1 = x2 a y1 = y2), výsledek je bod.
• Pokud se pole degeneruje na segment (x1 = x2 nebo y1 = y2, ale ne oba), výsledek je přímka se dvěma body.
• V opačném případě je výsledkem mnohoúhelník s pěti vrcholy (uzavřený prstenec).

Funkce vrátí None , pokud je některý ze vstupů None.

Příklady

# Returns the polygon envelope defined by two corners.
from pyspark.databricks.sql import functions as dbf
df = spark.createDataFrame([(1.0, 2.0, 4.0, 6.0)], ['x1', 'y1', 'x2', 'y2'])
df.select(dbf.st_astext(dbf.st_makeenvelope('x1', 'y1', 'x2', 'y2')).alias('result')).collect()

[Row(result='POLYGON((1 2,1 6,4 6,4 2,1 2))')]

# Corners may be provided in any order.
from pyspark.databricks.sql import functions as dbf
df = spark.createDataFrame([(4.0, 6.0, 1.0, 2.0)], ['x1', 'y1', 'x2', 'y2'])
df.select(dbf.st_astext(dbf.st_makeenvelope('x1', 'y1', 'x2', 'y2')).alias('result')).collect()

[Row(result='POLYGON((1 2,1 6,4 6,4 2,1 2))')]

# Returns a point when the box degenerates to a point.
from pyspark.databricks.sql import functions as dbf
df = spark.createDataFrame([(3.0, 5.0, 3.0, 5.0)], ['x1', 'y1', 'x2', 'y2'])
df.select(dbf.st_astext(dbf.st_makeenvelope('x1', 'y1', 'x2', 'y2')).alias('result')).collect()

[Row(result='POINT(3 5)')]

# Returns a linestring when the box degenerates to a horizontal segment.
from pyspark.databricks.sql import functions as dbf
df = spark.createDataFrame([(1.0, 0.0, 4.0, 0.0)], ['x1', 'y1', 'x2', 'y2'])
df.select(dbf.st_astext(dbf.st_makeenvelope('x1', 'y1', 'x2', 'y2')).alias('result')).collect()

[Row(result='LINESTRING(1 0,4 0)')]

# Returns a linestring when the box degenerates to a vertical segment.
from pyspark.databricks.sql import functions as dbf
df = spark.createDataFrame([(0.0, 2.0, 0.0, 7.0)], ['x1', 'y1', 'x2', 'y2'])
df.select(dbf.st_astext(dbf.st_makeenvelope('x1', 'y1', 'x2', 'y2')).alias('result')).collect()

[Row(result='LINESTRING(0 2,0 7)')]

# The SRID of the returned geometry is always 0.
from pyspark.databricks.sql import functions as dbf
df = spark.createDataFrame([(0.0, 0.0, 10.0, 10.0)], ['x1', 'y1', 'x2', 'y2'])
df.select(dbf.st_srid(dbf.st_makeenvelope('x1', 'y1', 'x2', 'y2')).alias('result')).collect()

[Row(result=0)]