Cli gdal proximity by elpaso · Pull Request #12350 · OSGeo/gdal

elpaso · 2025-05-12T14:22:43Z

Usage: gdal raster proximity [OPTIONS] <INPUT> <OUTPUT>

Produces a raster proximity map.

Positional arguments:
  -i, --input <INPUT>                                      Input raster dataset [required]
  -o, --output <OUTPUT>                                    Output raster dataset (created by algorithm) [required]

Common Options:
  -h, --help                                               Display help message and exit
  --json-usage                                             Display usage as JSON document and exit
  --config <KEY>=<VALUE>                                   Configuration option [may be repeated]
  --progress                                               Display progress bar

Options:
  -f, --of, --format, --output-format <OUTPUT-FORMAT>      Output format
  --co, --creation-option <KEY>=<VALUE>                    Creation option [may be repeated]
  --overwrite                                              Whether overwriting existing output is allowed
  --ot, --datatype, --output-data-type <OUTPUT-DATA-TYPE>  Output data type. OUTPUT-DATA-TYPE=Byte|Int8|UInt16|Int16|UInt32|Int32|UInt64|Int64|CInt16|CInt32|Float16|Float32|Float64|CFloat32|CFloat64|Byte|UInt16|Int16|UInt32|Int32|Float32|Float64 (default: Float32)
  -b, --band <BAND>                                        Input band (1-based index)
  --target-values <TARGET-VALUES>                          Target pixel values [may be repeated]
  --distance-units <DISTANCE-UNITS>                        Distance units. DISTANCE-UNITS=pixel|geo (default: pixel)
  --max-distance <MAX-DISTANCE>                            Maximum distance. The nodata value will be used for pixels beyond this distance (default: 0)
  --fixed-buffer <FIXED-BUFFER>                            Fixed buffer value (instead of the actual distance) (default: 0)
  --nodata <NODATA>                                        Specify a nodata value to use for pixels that are beyond the maximum distance

Advanced Options:
  --oo, --open-option <KEY>=<VALUE>                        Open options [may be repeated]
  --if, --input-format <INPUT-FORMAT>                      Input formats [may be repeated]

For more details, consult https://gdal.org/programs/gdal_raster_proximity.html

autotest/utilities/test_gdalalg_raster_proximity.py

apps/gdalalg_raster_proximity.cpp

Co-authored-by: Even Rouault <even.rouault@spatialys.com>

doc/source/programs/gdal_raster_proximity.rst

apps/gdalalg_raster_proximity.cpp

doc/source/programs/gdal_raster_proximity.rst

dbaston · 2025-05-12T18:12:04Z

doc/source/programs/gdal_raster_proximity.rst

+    Define a fixed value to be written in the output pixels that are within the
+    specified maximum distance from the target pixels, instead of the actual distance.
+
+.. option:: --nodata <NODATA>


Use --dst-nodata for consistency with other commands ?

I'm all in for consistency but we have a mixed situation already. Maybe worth filing a ticket to address the nodata argument altogether (and also the NoData camel case in the docs)?

Ticketed as: #12364

dbaston · 2025-05-12T18:12:23Z

doc/source/programs/gdal_raster_proximity.rst

+
+.. option:: --nodata <NODATA>
+
+    Nodata value for the output raster. If not specified, the nodata value of the input band will be used.


What happens if the input band does not have a NoData value?

According to https://gdal.org/en/stable/programs/gdal_proximity.html 65535 is used but let me write a few tests for that: I doubt that it will work with Byte output type.

Tests added and documentation expanded.

doc/source/programs/gdal_raster_proximity.rst

dbaston · 2025-05-12T18:16:48Z

doc/source/programs/gdal_raster_proximity.rst

+    georeferenced units (meters or degrees) using the pixel size of the input raster.
+    Otherwise, the distance is interpreted in pixels.
+
+.. option:: --fixed-buffer <FIXED-BUFFER>


This option name isn't very clear to me (although the description is.) Would --burn be appropriate, as in gdal vector rasterize ? Or --write-value ?

I'm happy to change it, burn means nothing to me (besides reminding of a fire). Wouldn't perhaps --fixed-value be more appropriate to convene the meaning that we are writing a fixed value instead of the varying distance?

--fixed-value sounds good.

dbaston · 2025-05-12T18:18:39Z

doc/source/programs/gdal_raster_proximity.rst

+
+    Nodata value for the output raster. If not specified, the nodata value of the input band will be used.
+
+.. option:: --respect-input-nodata


--propagate-nodata ?

I have removed the argument completely.

autotest/utilities/test_gdalalg_raster_proximity.py

apps/gdalalg_raster_proximity.cpp

doc/source/programs/gdal_raster_proximity.rst

jratike80 · 2025-05-12T18:31:52Z

doc/source/programs/gdal_raster_proximity.rst

+.. option:: --fixed-buffer <FIXED-BUFFER>
+
+    Define a fixed value to be written in the output pixels that are within the
+    specified maximum distance from the target pixels, instead of the actual distance.


Could it be then just fixed-value?

Could it be then just fixed-value?

I like it!

apps/gdalalg_raster_proximity.cpp

Co-authored-by: Even Rouault <even.rouault@spatialys.com> Co-authored-by: Dan Baston <dbaston@gmail.com>

apps/gdalalg_raster_proximity.cpp

autotest/utilities/test_gdalalg_raster_proximity.py

rouault · 2025-05-13T21:41:03Z

follow-up: make proximity pipeline compatible done in #12375

elpaso added 2 commits May 12, 2025 16:16

[cli] gdal raster proximity

32aa440

docs and test

0205fc5

elpaso added funded through GSP Work funded through the GDAL Sponsorship Program gdal_cli Anything related to the new 3.11 "gdal" CLI frontend labels May 12, 2025

rouault reviewed May 12, 2025

View reviewed changes

autotest/utilities/test_gdalalg_raster_proximity.py Outdated Show resolved Hide resolved

rouault reviewed May 12, 2025

View reviewed changes

apps/gdalalg_raster_proximity.cpp Outdated Show resolved Hide resolved

Update autotest/utilities/test_gdalalg_raster_proximity.py

d9f1711

Co-authored-by: Even Rouault <even.rouault@spatialys.com>

jratike80 reviewed May 12, 2025

View reviewed changes

doc/source/programs/gdal_raster_proximity.rst Show resolved Hide resolved

jratike80 reviewed May 12, 2025

View reviewed changes

doc/source/programs/gdal_raster_proximity.rst Show resolved Hide resolved

jratike80 reviewed May 12, 2025

View reviewed changes

doc/source/programs/gdal_raster_proximity.rst Outdated Show resolved Hide resolved

elpaso added 3 commits May 12, 2025 18:34

Remove respect-input-nodata option

8d5b52f

Think about retirement

df029cb

Try to be clearer in the docs

edf06ec

rouault reviewed May 12, 2025

View reviewed changes

apps/gdalalg_raster_proximity.cpp Show resolved Hide resolved

apps/gdalalg_raster_proximity.cpp Show resolved Hide resolved

apps/gdalalg_raster_proximity.cpp Outdated Show resolved Hide resolved

rouault reviewed May 12, 2025

View reviewed changes

doc/source/programs/gdal_raster_proximity.rst Outdated Show resolved Hide resolved

dbaston reviewed May 12, 2025

View reviewed changes

jratike80 reviewed May 12, 2025

View reviewed changes

apps/gdalalg_raster_proximity.cpp Outdated Show resolved Hide resolved

elpaso and others added 4 commits May 13, 2025 11:06

Apply suggestions from code review

0598a6d

Co-authored-by: Even Rouault <even.rouault@spatialys.com> Co-authored-by: Dan Baston <dbaston@gmail.com>

Address PR comments

8e33ee5

more pythonic?

fc4165f

Added tests and docs for the nodata defaults

bc91237

rouault reviewed May 13, 2025

View reviewed changes

apps/gdalalg_raster_proximity.cpp Outdated Show resolved Hide resolved

rouault reviewed May 13, 2025

View reviewed changes

apps/gdalalg_raster_proximity.cpp Outdated Show resolved Hide resolved

Remove unnecessary code

2c5fcb6

rouault reviewed May 13, 2025

View reviewed changes

autotest/utilities/test_gdalalg_raster_proximity.py Outdated Show resolved Hide resolved

Update autotest/utilities/test_gdalalg_raster_proximity.py

7481f87

rouault approved these changes May 13, 2025

View reviewed changes

rouault added this to the 3.12.0 milestone May 13, 2025

rouault merged commit 142e472 into OSGeo:master May 13, 2025
53 of 58 checks passed


		.. option:: --nodata <NODATA>

		Nodata value for the output raster. If not specified, the nodata value of the input band will be used.


		Nodata value for the output raster. If not specified, the nodata value of the input band will be used.

		.. option:: --respect-input-nodata

Uh oh!

Conversation

elpaso commented May 12, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

elpaso May 13, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

rouault commented May 13, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

elpaso commented May 12, 2025 •

edited

Loading

elpaso May 13, 2025 •

edited

Loading