ST_BinaryDistanceBandColumn (Python)

Creates a weights column containing the other records within the threshold and their weight. Weights will always be 1.0. SQL reference: ST_BinaryDistanceBandColumn

Signature

from sedona.spark.sql.st_functions import ST_BinaryDistanceBandColumn

ST_BinaryDistanceBandColumn(
    geometry: ColumnOrName,
    threshold: ColumnOrName,
    include_zero_distance_neighbors: Union[ColumnOrName, bool] = True,
    include_self: Union[ColumnOrName, bool] = False,
    use_spheroid: Union[ColumnOrName, bool] = False,
    attributes: ColumnOrName = None,
) -> Column

Parameters

ColumnOrName

required

Geometry column or name.

ColumnOrName

required

Distance threshold for considering neighbors.

Union[ColumnOrName, bool]

default:"True"

Whether to include neighbors that are 0 distance. Default is True.

Union[ColumnOrName, bool]

default:"False"

Whether to include the record itself in its list of neighbors. Default is False.

Union[ColumnOrName, bool]

default:"False"

Whether to use a cartesian or spheroidal distance calculation. Default is False.

ColumnOrName

default:"None"

Struct column of the attributes to save for each neighbor.

Returns

Column

Array of structs with each neighbor’s attributes and its weight.

​Signature

​Parameters

​Returns

Signature

Parameters

Returns