ST_WeightedDistanceBandColumn (Python)

Creates a weights column containing the other records within the threshold and their weight. Weights will be distance^alpha. SQL reference: ST_WeightedDistanceBandColumn

Signature

from sedona.spark.sql.st_functions import ST_WeightedDistanceBandColumn

ST_WeightedDistanceBandColumn(
    geometry: ColumnOrName,
    threshold: ColumnOrName,
    alpha: Union[ColumnOrName, float],
    include_zero_distance_neighbors: Union[ColumnOrName, bool] = True,
    include_self: Union[ColumnOrName, bool] = False,
    self_weight: Union[ColumnOrName, float] = 1.0,
    use_spheroid: Union[ColumnOrName, bool] = False,
    attributes: ColumnOrName = None,
) -> Column

Parameters

ColumnOrName

required

name of the geometry column

ColumnOrName

required

Distance threshold for considering neighbors

Union[ColumnOrName, float]

required

alpha to use for inverse distance weights. Computation is dist^alpha. Default is -1.0

Union[ColumnOrName, bool]

default:"True"

whether to include neighbors that are 0 distance. If 0 distance neighbors are included, values are infinity as per the floating point spec (divide by 0)

Union[ColumnOrName, bool]

default:"False"

whether to include self in the list of neighbors

Union[ColumnOrName, float]

default:"1.0"

the value to use for the self weight. Default is 1.0

Union[ColumnOrName, bool]

default:"False"

whether to use a cartesian or spheroidal distance calculation. Default is false

ColumnOrName

default:"None"

the attributes to save in the neighbor column.

​Signature

​Parameters

Signature

Parameters