geo-registry

gdal:proximity

How QGIS runs Euclidean Distance: gdal:proximity.

About this implementation
Engine QGIS
Tool name gdal:proximity
Interface qgis-process
Implements Euclidean Distance
Preset {"UNITS":0}
Documentation Not stated
Effects modifies input: no, network: no
Notes Not stated
Status active

Parameters

Name Type Required Default Choices Note
BAND band yes 1 Not stated Not stated
CREATION_OPTIONS string no Not stated Not stated Not stated
DATA_TYPE enum yes 5 0, 1, 10, 11, 2, 3, 4, 5, 6, 7, 8, 9 0 Byte, 1 Int16, 10 CFloat64, 11 Int8, 2 UInt16, 3 UInt32, 4 Int32, 5 Float32, 6 Float64, 7 CInt16, 8 CInt32, 9 CFloat32
EXTRA string no Not stated Not stated Not stated
INPUT raster yes Not stated Not stated Not stated
MAX_DISTANCE number no 0 Not stated Not stated
NODATA number no 0 Not stated Not stated
OUTPUT rasterDestination yes Not stated Not stated output
REPLACE number no 0 Not stated Not stated
UNITS enum yes 1 0, 1 0 Georeferenced coordinates, 1 Pixel coordinates
VALUES string no Not stated Not stated Not stated

How it maps to the operation

Operation parameter Parameter here Note
raster INPUT Not stated
output OUTPUT Not stated

Differences from the operation

  • Runs GDAL's proximity. Targets are non-zero cells unless VALUES lists them; nodata cells are not zero, so on a background of nodata every cell is a target (all distances 0), and with target values listed the background cells get 65535 instead of a distance: give the background as 0.
  • UNITS 1 (the default) gives distances in cells, 0 in the CRS's units (set by this mapping).

Harvested by the qgis harvester from engine version 4.2.3. Names can change when an engine is harvested again.