gdal raster proximity
How GDAL runs Euclidean Distance: gdal raster proximity.
| Engine | GDAL |
|---|---|
| Tool name | gdal raster proximity |
| Interface | cli |
| Implements | Euclidean Distance |
| Preset | {"distance-units":"geo"} |
| Documentation | https://gdal.org/programs/gdal_raster_proximity.html |
| Effects | modifies input: no, network: no |
| Notes | Not stated |
| Status | active |
Parameters
| Name | Type | Required | Default | Choices | Note |
|---|---|---|---|---|---|
input-format | string_list | no | Not stated | Not stated | Not stated |
open-option | string_list | no | Not stated | Not stated | Not stated |
input | dataset_list | yes | Not stated | Not stated | raster dataset |
output-format | string | no | Not stated | Not stated | Not stated |
creation-option | string_list | no | Not stated | Not stated | Not stated |
overwrite | boolean | no | no | Not stated | exclusive group overwrite-append |
append | boolean | no | no | Not stated | exclusive group overwrite-append |
output-data-type | string | no | Float32 | UInt8, Int8, UInt16, Int16, UInt32, Int32, UInt64, Int64, CInt16, CInt32, Float16, Float32, Float64, CFloat32, CFloat64, Byte | Not stated |
band | integer | no | Not stated | Not stated | Not stated |
target-values | real_list | no | Not stated | Not stated | Not stated |
distance-units | string | no | pixel | pixel, geo | Not stated |
max-distance | real | no | 0 | Not stated | Not stated |
fixed-value | real | no | 0 | Not stated | at least 0.0 |
nodata | real | no | Not stated | Not stated | Not stated |
output | dataset | yes | Not stated | Not stated | input and output; raster dataset |
How it maps to the operation
| Operation parameter | Parameter here | Note |
|---|---|---|
raster | input | Not stated |
output | output | Not stated |
Differences from the operation
- Targets are non-zero cells unless target-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.
- Distances are in cells unless distance-units is geo (set by this mapping).
Harvested by the gdal harvester from engine version
3.13.3. Names can change when an engine is harvested again.