jord.shapely_utilities.points.nearest_neighbor_within#

jord.shapely_utilities.points.nearest_neighbor_within(others: Sequence, point, max_distance) → Point | None[source]#

Find the nearest point among others up to a maximum distance.

Parameters:

  • others – a list of Points or a MultiPoint

  • point – a Point

  • max_distance – maximum distance to search for the nearest neighbor

Returns:

A shapely Point if one is within max_distance, None otherwise

Return type:

Optional[Point]