
/*!
\if man
\page gdal_proximity
\else
\page gdal_proximity gdal_proximity.py
\endif

Produces a raster proximity map.

\section gdal_proximity_synopsis SYNOPSIS

\verbatim
gdal_proximity.py srcfile dstfile [-srcband n] [-dstband n]
                  [-of format] [-co name=value]*
                  [-ot Byte/Int16/Int32/Float32/etc]
                  [-values n,n,n] [-distunits PIXEL/GEO]
                  [-maxdist n] [-nodata n] [-use_input_nodata YES/NO]
                  [-fixed-buf-val n]
\endverbatim

\section gdal_proximity_description DESCRIPTION

The gdal_proximity.py script generates a raster proximity map indicating
the distance from the center of each pixel to the center of the nearest
pixel identified as a target pixel.  Target pixels are those in the source
raster for which the raster pixel value is in the set of target pixel values.

<dl>
<dt> <i>srcfile</i></dt><dd> The source raster file used to identify target pixels.</dd>

<dt> <i>dstfile</i></dt><dd> The destination raster file to which the proximity map will be written.  It may be a pre-existing file of the same size as srcfile.  If it does not exist it will be created.</dd>

<dt> <b>-srcband</b> <i>n</i></dt><dd> Identifies the band in the source file to use (default is 1).</dd>

<dt> <b>-dstband</b> <i>n</i></dt><dd> Identifies the band in the destination file to use (default is 1).</dd>

<dt> <b>-of</b> <em>format</em>:</dt><dd> Select the output format. Starting with
GDAL 2.3, if not specified, the format is guessed from the extension (previously
was GTiff). Use the short format name.</dd>

<dt> <b>-co</b> <em>"NAME=VALUE"</em>:</dt><dd> passes a creation option to
the output format driver. Multiple <b>-co</b> options may be listed. See
format specific documentation for legal creation options for each format.
</dd>

<dt> <b>-ot</b> <i>datatype</i>:</dt><dd>
Force the output image bands to have a specific type. Use type names (i.e. Byte, Int16,...)
</dd>

<dt> <b>-values</b> <i>n,n,n</i>:</dt><dd>
A list of target pixel values in the source image to be considered target
pixels. If not specified, all non-zero pixels will be considered target pixels.
</dd>

<dt> <b>-distunits</b> <i>PIXEL/GEO</i>:</dt><dd>
Indicate whether distances generated should be in pixel or georeferenced
coordinates (default PIXEL).
</dd>

<dt> <b>-maxdist</b> <i>n</i>:</dt><dd>
The maximum distance to be generated. The nodata value will be used for pixels
beyond this distance. If a nodata value is not provided, the output band will be
queried for its nodata value. If the output band does not have a nodata value,
then the value 65535 will be used. Distance is interpreted in pixels unless
-distunits GEO is specified.
</dd>

<dt> <b>-nodata</b> <i>n</i>:</dt><dd>
Specify a nodata value to use for the destination proximity raster.
</dd>

<dt> <b>-use_input_nodata</b> <i>YES/NO</i>:</dt><dd> (GDAL &gt;= 2.0)
Indicate whether nodata pixels in the input raster should be nodata in the output raster (default NO).
</dd>

<dt> <b>-fixed-buf-val</b> <i>n</i>:</dt><dd>
Specify a value to be applied to all pixels that are within the -maxdist of target pixels (including the target pixels) instead of a distance value.
</dd>

</dl>

\if man
\section gdal_proximity_author AUTHORS
Frank Warmerdam <warmerdam@pobox.com>
\endif
*/

