geo-registry

xrspatial.proximity

How xarray-spatial runs Euclidean Distance: xrspatial.proximity.

About this implementation
Engine xarray-spatial
Tool name xrspatial.proximity
Interface python
Implements Euclidean Distance
Documentation Not stated
Effects modifies input: no, network: no
Notes Not stated
Status active

Parameters

Name Type Required Default Choices Note
raster DataArray yes Not stated Not stated Not stated
x str no x Not stated Not stated
y str no y Not stated Not stated
target_values list no Not stated Not stated Not stated
max_distance float no Not stated Not stated default inf
distance_metric str no EUCLIDEAN Not stated Not stated

How it maps to the operation

Operation parameter Parameter here Note
raster raster Not stated

Differences from the operation

  • Takes an xarray DataArray; targets are non-zero cells unless target_values lists them.
  • distance_metric also offers Great Circle and Manhattan.

Harvested by the python-packages harvester from engine version 0.10.20. Names can change when an engine is harvested again.