ST_HilbertDistance (Python)

Map a geometry-envelope midpoint to a Hilbert curve distance. SQL reference: ST_HilbertDistance

Signature

from sedona.spark.sql.st_functions import ST_HilbertDistance

ST_HilbertDistance(
    geometry: ColumnOrName,
    min_x: ColumnOrNameOrNumber,
    min_y: ColumnOrNameOrNumber,
    max_x: ColumnOrNameOrNumber,
    max_y: ColumnOrNameOrNumber,
    level: Union[ColumnOrName, int],
) -> Column

Parameters

ColumnOrName

required

Geometry whose envelope midpoint is encoded.

ColumnOrNameOrNumber

required

Minimum X of the Hilbert curve extent.

ColumnOrNameOrNumber

required

Minimum Y of the Hilbert curve extent.

ColumnOrNameOrNumber

required

Maximum X of the Hilbert curve extent.

ColumnOrNameOrNumber

required

Maximum Y of the Hilbert curve extent.

Union[ColumnOrName, int]

required

Hilbert curve level, at most 16.

Returns

Column

Non-negative Hilbert curve distance as a long column.

​Signature

​Parameters

​Returns

Signature

Parameters

Returns