ST_H3KRing (Python)

Cover Geometry with H3 Cells and return a List of Long type cell IDs SQL reference: ST_H3KRing

Signature

from sedona.spark.sql.st_functions import ST_H3KRing

ST_H3KRing(
    cell: Union[ColumnOrName, int],
    k: Union[ColumnOrName, int],
    exact_ring: Union[ColumnOrName, bool],
) -> Column

Parameters

Union[ColumnOrName, int]

required

original cell

Union[ColumnOrName, int]

required

the k number of rings spread from the original cell

Union[ColumnOrName, bool]

required

if exactDistance is true, it will only return the cells on the exact kth ring, else will return all 0 - kth neighbors

Returns

List[long]

List of cellIDs

​Signature

​Parameters

​Returns

Signature

Parameters

Returns