geoutils.Vector.proximity

Vector.proximity(raster=None, size=(1000, 1000), distance_unit='georeferenced', max_distance=None, mp_config=None)

Compute proximity distances to this vector’s current geometry.

Apply a geometry operation before proximity() to use a derived geometry, for example vector.boundary.proximity(raster).

Parameters:

• raster (TypeVar(RasterType, bound= RasterBase) | None) – Raster whose grid is used for the proximity output.

• size (tuple[int, int]) – Output width and height when raster is not provided.

• distance_unit (Literal['pixel'] | Literal['georeferenced']) – Calculate distance in georeferenced or pixel units.

• max_distance (float | None) – Largest distance to return, with farther cells set to nodata. This value is required for Dask and multiprocessing execution because it defines the overlap between chunks.

• mp_config (MultiprocConfig | None) – Multiprocessing parameters. Cannot be combined with Dask input.

Return type:

TypeVar(RasterType, bound= RasterBase)

Returns:

Raster of proximity distances on the selected grid.