EVOLUTION-MANAGER

Edit File: gdal_utilities.dox

#ifndef DOXYGEN_SKIP
/* $Id: gdal_utilities.dox 37978 2017-04-13 15:25:54Z rouault $ */
#endif /* DOXYGEN_SKIP */

/*!
\page gdal_utilities GDAL Utilities
\brief A collection of GDAL related programs.

The following utility programs are distributed with GDAL.

<ul>
<li> \ref gdalinfo - Report information about a file.
<li> \ref gdal_translate - Copy a raster file, with control of output format.
<li> \ref gdaladdo - Add overviews to a file.
<li> \ref gdalwarp - Warp an image into a new coordinate system.
<li> \ref gdaltindex - Build a MapServer raster tileindex.
<li> \ref gdalbuildvrt - Build a VRT from a list of datasets.
<li> \ref gdal_contour - Contours from DEM.
<li> \ref gdaldem - Tools to analyze and visualize DEMs.
<li> \ref rgb2pct - Convert a 24bit RGB image to 8bit paletted.
<li> \ref pct2rgb - Convert an 8bit paletted image to 24bit RGB.
<li> \ref gdal_merge - Build a quick mosaic from a set of images.
<li> \ref gdal2tiles - Create a TMS tile structure, KML and simple web viewer.
<li> \ref gdal_rasterize - Rasterize vectors into raster file.
<li> \ref gdaltransform - Transform coordinates.
<li> \ref nearblack - Convert nearly black/white borders to exact value.
<li> \ref gdal_retile - Retiles a set of tiles and/or build tiled pyramid levels.
<li> \ref gdal_grid - Create raster from the scattered data.
<li> \ref gdal_proximity - Compute a raster proximity map.
<li> \ref gdal_polygonize - Generate polygons from raster.
<li> \ref gdal_sieve - Raster Sieve filter.
<li> \ref gdal_fillnodata - Interpolate in nodata regions.
<li> \ref gdallocationinfo - Query raster at a location.
<li> \ref gdalsrsinfo - Report a given SRS in different formats. (GDAL >= 1.9.0)
<li> \ref gdalmove - Transform the coordinate system of a file (GDAL >= 1.10)
<li> \ref gdal_edit - Edit in place various information of an existing GDAL dataset (projection, geotransform, nodata, metadata)
<li> \ref gdal_calc - Command line raster calculator with numpy syntax
<li> \ref gdal_pansharpen - Perform a pansharpen operation.
<li> \ref gdal-config - Get options required to build software using GDAL.
<li> \ref gdalmanage - Identify, copy, rename and delete raster.
<li> \ref gdalcompare - Compare two images and report on differences.
</ul>

\section gdal_utilities_creating Creating New Files

Access an existing file to read it is generally quite simple. Just
indicate the name of the file or dataset on the command line. However,
creating a file is more complicated. It may be necessary to indicate the
the format to create, various creation options affecting how it will
be created and perhaps a coordinate system to be assigned. Many of
these options are handled similarly by different GDAL utilities, and are
introduced here.

<dl>
<dt> -of format</dt><dd>
Select the format to create the new file as. The formats are assigned short
names such as GTiff (for GeoTIFF) or HFA (for Erdas Imagine). The list of
all format codes can be listed with the \-\-formats switch. Only
formats list as "(rw)" (read-write) can be written.
Many utilities default
to creating GeoTIFF files if a format is not specified. File extensions
are not used to guess output format, nor are extensions generally added
by GDAL if not indicated in the filename by the user.
</dd>

<dt> -co NAME=VALUE</dt><dd>
Many formats have one or more optional creation options that can be used
to control particulars about the file created. For instance, the GeoTIFF
driver supports creation options to control compression, and whether the file
should be tiled.
The creation options available vary by format driver, and some simple
formats have no creation options at all. A list of options supported
for a format can be listed with the "--format <format>" command line
option but the web page for the format is the definitive source of
information on driver creation options. See <a class="el"
href="formats_list.html" title="GDAL Raster Formats">format specific
documentation for legal creation options for each format</a>
</dd>

<dt> -a_srs SRS</dt><dd>
Several utilities, (gdal_translate and gdalwarp) include the ability
to specify coordinate systems with command line options like
-a_srs (assign SRS to output), -s_srs (source SRS) and
-t_srs (target SRS).
These utilities allow the coordinate system (SRS = spatial reference system)
to be assigned in a variety of formats.

<ul>
<li> NAD27/NAD83/WGS84/WGS72:
These common geographic (lat/long) coordinate
systems can be used directly by these names.

<li> EPSG:n: Coordinate systems (projected or geographic) can
be selected based on their EPSG codes, for instance EPSG:27700 is the British
National Grid. A list of EPSG coordinate systems can be found in the GDAL
data files gcs.csv and pcs.csv.

<li> PROJ.4 Definitions: A PROJ.4 definition string can be used
as a coordinate system. For instance "+proj=utm +zone=11 +datum=WGS84".
Take care to keep the proj.4 string together as a single argument to the
command (usually by double quoting).

<li> OpenGIS Well Known Text: The Open GIS Consortium has defined
a textual format for describing coordinate systems as part of the Simple
Features specifications. This format is the internal working format
for coordinate systems used in GDAL. The name of a file containing a
WKT coordinate system definition may be used a coordinate system argument,
or the entire coordinate system itself may be used as a command line
option (though escaping all the quotes in WKT is quite challenging).

<li> ESRI Well Known Text: ESRI uses a slight variation on OGC WKT
format in their ArcGIS product (ArcGIS .prj files), and these may be used
in a similar manner to WKT files, but the filename should be prefixed with
ESRI::. For example "ESRI::NAD 1927 StatePlane Wyoming West FIPS 4904.prj".

<li> Spatial References from URLs: For example
http://spatialreference.org/ref/user/north-pacific-albers-conic-equal-area/.

<li> filename: The name of a file containing WKT, PROJ.4 strings, or
XML/GML coordinate system definitions can be provided.

</ul>
</dd>
</dl>

\section gdal_utilities_switches General Command Line Switches
All GDAL command line utility programs support the following
"general" options.

<dl>
<dt> \-\-version</dt><dd> Report the version of GDAL and exit.</dd>

<dt> \-\-formats</dt><dd> List all raster formats supported by this
GDAL build (read-only and read-write) and exit. The format support is indicated
 as follows: 'ro' is read-only driver;
'rw' is read or write (i.e. supports CreateCopy);
'rw+' is read, write and update (i.e. supports Create).
A 'v' is appended for formats supporting virtual IO (/vsimem, /vsigzip, /vsizip, etc).
A 's' is appended for formats supporting subdatasets.
Note: The valid formats for the output of gdalwarp are formats that support the
Create() method (marked as rw+), not just the CreateCopy() method.
</dd>

<dt> \-\-format format</dt><dd>
List detailed information about a single format driver. The format
should be the short name reported in the \-\-formats list, such as
GTiff.</dd>

<dt> \-\-optfile file</dt><dd>
Read the named file and substitute the contents into the command line
options list. Lines beginning with # will be ignored. Multi-word arguments
may be kept together with double quotes.
</dd>

<dt> \-\-config key value</dt><dd>
Sets the named <a href="http://trac.osgeo.org/gdal/wiki/ConfigOptions">
configuration keyword</a> to the given value, as opposed to
setting them as environment variables. Some common configuration keywords
are GDAL_CACHEMAX (memory used internally for caching in megabytes)
and GDAL_DATA (path of the GDAL "data" directory). Individual drivers may
be influenced by other configuration options.
</dd>

<dt> \-\-debug value</dt><dd>
Control what debugging messages are emitted. A value of ON will
enable all debug messages. A value of OFF will disable all debug
messages. Another value will select only debug messages containing that
string in the debug prefix code.
</dd>

<dt> \-\-help-general</dt><dd>
Gives a brief usage message for the generic GDAL command line options
and exit.
</dd>

</dl>

\htmlonly

$Id: gdal_utilities.dox 37978 2017-04-13 15:25:54Z rouault $

\endhtmlonly
*/

*******************************************************************************
/*!
\if man
\page gdalinfo
\else
\page gdalinfo gdalinfo
\endif

Lists information about a raster dataset.

\section gdalinfo_synopsis SYNOPSIS

\verbatim
gdalinfo [--help-general] [-json] [-mm] [-stats] [-hist] [-nogcp] [-nomd]
         [-norat] [-noct] [-nofl] [-checksum] [-proj4]
         [-listmdd] [-mdd domain|`all`]*
         [-sd subdataset] [-oo NAME=VALUE]* datasetname
\endverbatim

\section gdalinfo_description DESCRIPTION

The gdalinfo program lists various information about a GDAL supported
raster dataset.
<dl>
<dt> -json</dt><dd> Display the output in json format.</dd>
<dt> -mm</dt><dd> Force computation of the actual min/max values for each
band in the dataset.</dd>
<dt> -stats</dt><dd> Read and display image statistics. Force computation if no statistics are stored in an image.</dd>
<dt> -approx_stats</dt><dd> Read and display image statistics. Force
computation if no statistics are stored in an image. However, they may be
computed based on overviews or a subset of all tiles. Useful if you are in a
hurry and don't want precise stats.</dd>
<dt> -hist</dt><dd> Report histogram information for all bands.</dd>
<dt> -nogcp</dt><dd> Suppress ground control points list printing. It may be
useful for datasets with huge amount of GCPs, such as L1B AVHRR or HDF4 MODIS
which contain thousands of them.</dd>
<dt> -nomd</dt><dd> Suppress metadata printing. Some datasets may contain a lot
of metadata strings.</dd>
<dt> -norat</dt><dd> Suppress printing of raster attribute table.</dd>
<dt> -noct</dt><dd> Suppress printing of color table.</dd>
<dt> -checksum</dt><dd> Force computation of the checksum for each band in the dataset.</dd>
<dt> -listmdd</dt><dd> (GDAL >= 1.11) List all metadata domains available for the dataset.</dd>
<dt> -mdd domain</dt><dd> Report metadata for the specified domain. Starting with GDAL 1.11,
"all" can be used to report metadata in all domains</dd>
<dt> -nofl</dt><dd> (GDAL >= 1.9.0) Only display the first file of the
file list.</dd>
<dt> -sd subdataset</dt><dd> (GDAL >= 1.9.0) If the input
dataset contains several subdatasets read and display a subdataset with
specified number (starting from 1). This is an alternative of giving the full
subdataset name.</dd>
<dt> -proj4</dt><dd> (GDAL >= 1.9.0) Report a PROJ.4 string corresponding to the file's coordinate system.</dd>
<dt> -oo NAME=VALUE:</dt><dd>(starting with GDAL 2.0) Dataset open option (format specific)</dd>
</dl>

The gdalinfo will report all of the following (if known):

<ul>
<li> The format driver used to access the file.
<li> Raster size (in pixels and lines).
<li> The coordinate system for the file (in OGC WKT).
<li> The geotransform associated with the file (rotational coefficients are
currently not reported).
<li> Corner coordinates in georeferenced, and if possible lat/long based on
the full geotransform (but not GCPs).
<li> Ground control points.
<li> File wide (including subdatasets) metadata.
<li> Band data types.
<li> Band color interpretations.
<li> Band block size.
<li> Band descriptions.
<li> Band min/max values (internally known and possibly computed).
<li> Band checksum (if computation asked).
<li> Band NODATA value.
<li> Band overview resolutions available.
<li> Band unit type (i.e.. "meters" or "feet" for elevation bands).
<li> Band pseudo-color tables.
</ul>

\section gdalinfo_api C API

Starting with GDAL 2.1, this utility is also callable from C with GDALInfo().

\section gdalinfo_example EXAMPLE

\verbatim
gdalinfo ~/openev/utm.tif
Driver: GTiff/GeoTIFF
Size is 512, 512
Coordinate System is:
PROJCS["NAD27 / UTM zone 11N",
    GEOGCS["NAD27",
        DATUM["North_American_Datum_1927",
            SPHEROID["Clarke 1866",6378206.4,294.978698213901]],
        PRIMEM["Greenwich",0],
        UNIT["degree",0.0174532925199433]],
    PROJECTION["Transverse_Mercator"],
    PARAMETER["latitude_of_origin",0],
    PARAMETER["central_meridian",-117],
    PARAMETER["scale_factor",0.9996],
    PARAMETER["false_easting",500000],
    PARAMETER["false_northing",0],
    UNIT["metre",1]]
Origin = (440720.000000,3751320.000000)
Pixel Size = (60.000000,-60.000000)
Corner Coordinates:
Upper Left  (  440720.000, 3751320.000) (117d38'28.21"W, 33d54'8.47"N)
Lower Left  (  440720.000, 3720600.000) (117d38'20.79"W, 33d37'31.04"N)
Upper Right (  471440.000, 3751320.000) (117d18'32.07"W, 33d54'13.08"N)
Lower Right (  471440.000, 3720600.000) (117d18'28.50"W, 33d37'35.61"N)
Center      (  456080.000, 3735960.000) (117d28'27.39"W, 33d45'52.46"N)
Band 1 Block=512x16 Type=Byte, ColorInterp=Gray
\endverbatim

\if man
\section gdalinfo_author AUTHORS
Frank Warmerdam <warmerdam@pobox.com>, Silke Reimer <silke@intevation.de>
\endif
*/

*******************************************************************************
/*!
\if man
\page gdal_translate
\else
\page gdal_translate gdal_translate
\endif

Converts raster data between different formats.

\section gdal_translate_synopsis SYNOPSIS

\verbatim
gdal_translate [--help-general]
       [-ot {Byte/Int16/UInt16/UInt32/Int32/Float32/Float64/
             CInt16/CInt32/CFloat32/CFloat64}] [-strict]
       [-of format] [-b band]* [-mask band] [-expand {gray|rgb|rgba}]
       [-outsize xsize[%]|0 ysize[%]|0] [-tr xres yres]
       [-r {nearest,bilinear,cubic,cubicspline,lanczos,average,mode}]
       [-unscale] [-scale[_bn] [src_min src_max [dst_min dst_max]]]* [-exponent[_bn] exp_val]*
       [-srcwin xoff yoff xsize ysize] [-epo] [-eco]
       [-projwin ulx uly lrx lry] [-projwin_srs srs_def]
       [-a_srs srs_def] [-a_ullr ulx uly lrx lry] [-a_nodata value]
       [-gcp pixel line easting northing [elevation]]*
       [-mo "META-TAG=VALUE"]* [-q] [-sds]
       [-co "NAME=VALUE"]* [-stats] [-norat]
       [-oo NAME=VALUE]*
       src_dataset dst_dataset
\endverbatim

\section gdal_translate_description DESCRIPTION

The gdal_translate utility can be used to convert raster data between
different formats, potentially performing some operations like subsettings,
resampling, and rescaling pixels in the process.

<dl>
<dt> -ot: type</dt><dd> For the output bands to be of the
indicated data type.</dd>
<dt> -strict:</dt><dd> Don't be forgiving of mismatches and lost data
when translating to the output format.</dd>
<dt> -of format:</dt><dd> Select the output format. The default
is GeoTIFF (GTiff). Use the short format name.</dd>
<dt> -b band:</dt><dd> Select an input band band for
output. Bands are numbered from 1. Multiple -b switches may be used
to select a set of input bands to write to the output file, or to reorder
bands. Starting with GDAL 1.8.0, band can also be set to "mask,1"
(or just "mask") to mean the mask band of the first band of the input dataset.</dd>
<dt> -mask band:</dt><dd> (GDAL >= 1.8.0) Select an input band
band to create output dataset mask band. Bands are numbered from 1.
band can be set to "none" to avoid copying the global mask of the input dataset if
it exists. Otherwise it is copied by default ("auto"), unless the mask is an alpha channel,
or if it is explicitly used to be a regular band of the output dataset ("-b mask").
band can also be set to "mask,1" (or just "mask") to mean the mask band of
the 1st band of the input dataset.</dd>
<dt> -expand gray|rgb|rgba:</dt><dd> (From GDAL 1.6.0) To expose a dataset with 1 band
with a color table as a dataset with 3 (RGB) or 4 (RGBA) bands. Useful for
output drivers such as JPEG, JPEG2000, MrSID, ECW that don't support color
indexed datasets. The 'gray' value (from GDAL 1.7.0) enables to expand a
dataset with a color table that only contains gray levels to a gray indexed
dataset.</dd>
<dt> -outsize xsize[%]|0 ysize[%]|0:</dt><dd> Set the size of the output
file. Outsize is in pixels and lines unless '\%' is attached in which case it
is as a fraction of the input image size. Starting with GDAL 2.0, if one of the
2 values is set to 0, its value will be determined from the other one,
while maintaining the aspect ratio of the source dataset.</dd>
<dt> -tr xres yres :</dt><dd> (starting with GDAL 2.0)
set target resolution. The values must be expressed in georeferenced units.
Both must be positive values. This is mutually exclusive with -outsize and -a_ullr.
</dd>
<dt> -r
{nearest (default),bilinear,cubic,cubicspline,lanczos,average,mode}:</dt><dd>
(GDAL &gt;= 2.0) Select a resampling algorithm.</dd>
<dt> -scale [src_min src_max [dst_min dst_max]]:</dt><dd> Rescale the
input pixels values from the range src_min to src_max to
the range dst_min to dst_max. If omitted the output range is
0 to 255. If omitted the input range is automatically computed from the
source data.
Before GDAL 1.11, it can be specified only once, and in that case, it applies to
all bands of the output dataset.
Starting with GDAL 1.11, -scale can be repeated several times (if specified only once,
it also applies to all bands of the output dataset), so as to specify per band parameters.
It is also possible to use the "-scale_bn" syntax where bn is a band number
(e.g. "-scale_2" for the 2nd band of the output dataset) to specify the parameters of
one or several specific bands.
</dd>
<dt> -exponent exp_val:</dt><dd> (From GDAL 1.11) To apply non-linear scaling
with a power function. exp_val is the exponent of the power function (must be positive). This option
must be used with the -scale option.
If specified only once, -exponent applies to all bands of the output image.
It can be repeated several times so as to specify per band parameters.
It is also possible to use the "-exponent_bn" syntax where bn is a band number
(e.g. "-exponent_2" for the 2nd band of the output dataset) to specify the parameters of
one or several specific bands.
</dd>
<dt> -unscale:</dt><dd> Apply the scale/offset metadata for the bands
to convert scaled values to unscaled values. It is also often necessary to
reset the output datatype with the -ot switch.</dd>
<dt> -srcwin xoff yoff xsize ysize:</dt><dd> Selects a subwindow
from the source image for copying based on pixel/line location. </dd>
<dt> -projwin ulx uly lrx lry:</dt><dd> Selects a subwindow from
the source image for copying (like -srcwin) but with the corners given
in georeferenced coordinates (by default expressed in the SRS of the dataset. Can be
changed with -projwin_srs).
Note: in GDAL 2.1.0 and 2.1.1, using -projwin with coordinates not aligned with
pixels will result in a sub-pixel shift. This has been corrected in later versions.
When selecting non-nearest neighbour resampling, starting with GDAL 2.1.0,
sub-pixel accuracy is however used to get better results.</dd>
<dt> -projwin_srs srs_def:</dt><dd> (GDAL >= 2.0) Specifies the SRS in
which to interpret the coordinates given with -projwin. The srs_def may
be any of the usual GDAL/OGR forms, complete WKT, PROJ.4, EPSG:n or a file
containing the WKT.
Note that this does not cause reprojection of the dataset to the specified SRS. </dd>
<dt> -epo: (Error when Partially Outside)</dt><dd>(GDAL >= 1.10) If this
option is set, -srcwin or -projwin values that falls partially outside the
source raster extent will be considered as an error. The default behaviour starting
with GDAL 1.10 is to accept such requests, when they were considered as an error before.</dd>
<dt> -eco: (Error when Completely Outside)</dt><dd>(GDAL >= 1.10) Same
as -epo, except that the criterion for erroring out is when the request falls completely
outside the source raster extent.</dd>
<dt> -a_srs srs_def:</dt><dd> Override the projection for the
output file. The srs_def may be any of the usual GDAL/OGR forms,
complete WKT, PROJ.4, EPSG:n or a file containing the WKT. </dd>
<dt> -a_ullr ulx uly lrx lry:</dt><dd>
Assign/override the georeferenced bounds of the output file. This assigns
georeferenced bounds to the output file, ignoring what would have been derived
from the source file. So this does not cause reprojection to the specified SRS. </dd>
<dt> -a_nodata value:</dt><dd>
Assign a specified nodata value to output bands. Starting with GDAL 1.8.0, can
be set to none to avoid setting a nodata value to the output file if
one exists for the source file. Note that, if the input dataset has a
nodata value, this does not cause pixel values that are equal to that nodata
value to be changed to the value specified with this option.</dd>
<dt> -mo "META-TAG=VALUE":</dt><dd> Passes a metadata key and
value to set on the output dataset if possible.</dd>
<dt> -co "NAME=VALUE":</dt><dd> Passes a creation option to the
output format driver. Multiple -co options may be listed. See <a class="el"
href="formats_list.html" title="GDAL Raster Formats">format specific
documentation for legal creation options for each format</a>.</dd>
<dt> -gcp pixel line easting northing elevation:</dt><dd>
Add the indicated ground control point to the output dataset. This option
may be provided multiple times to provide a set of GCPs.
</dd>
<dt> -q:</dt><dd> Suppress progress monitor and other non-error
output.</dd>
<dt> -sds:</dt><dd> Copy all subdatasets of this file to individual
output files. Use with formats like HDF or OGDI that have subdatasets.
The output file naming scheme has changed in GDAL 1.11 (e.g. ofile_1.tif, ofile_2.tif).</dd>
<dt> -stats:</dt><dd> (GDAL >= 1.8.0) Force (re)computation of statistics.</dd>
<dt> -norat</dt><dd> (GDAL >= 1.11) Do not copy source RAT into destination dataset.</dd>
<dt> -oo NAME=VALUE:</dt><dd>(starting with GDAL 2.0) Dataset open option (format specific)</dd>
<dt> src_dataset:</dt><dd>The source dataset name. It can be either
file name, URL of data source or subdataset name for multi-dataset files.</dd>
<dt> dst_dataset:</dt><dd> The destination file name.</dd>
</dl>

\section gdal_translate_api C API

Starting with GDAL 2.1, this utility is also callable from C with GDALTranslate().

\section gdal_translate_example EXAMPLE

\verbatim
gdal_translate -of GTiff -co "TILED=YES" utm.tif utm_tiled.tif
\endverbatim

Starting with GDAL 1.8.0, to create a JPEG-compressed TIFF with internal mask from a RGBA dataset :
\verbatim
gdal_translate rgba.tif withmask.tif -b 1 -b 2 -b 3 -mask 4 -co COMPRESS=JPEG -co PHOTOMETRIC=YCBCR --config GDAL_TIFF_INTERNAL_MASK YES
\endverbatim

Starting with GDAL 1.8.0, to create a RGBA dataset from a RGB dataset with a mask :
\verbatim
gdal_translate withmask.tif rgba.tif -b 1 -b 2 -b 3 -b mask
\endverbatim

\if man
\section gdal_translate_author AUTHORS
Frank Warmerdam <warmerdam@pobox.com>, Silke Reimer <silke@intevation.de>
\endif
*/

*******************************************************************************
/*!
\if man
\page gdaladdo
\else
\page gdaladdo gdaladdo
\endif

Builds or rebuilds overview images.

\section gdaladdo_synopsis SYNOPSIS

\verbatim
gdaladdo [-r {nearest,average,gauss,cubic,cubicspline,lanczos,average_mp,average_magphase,mode}]
         [-b band]*
         [-ro] [-clean] [-oo NAME=VALUE]* [--help-general] filename levels
\endverbatim

\section gdaladdo_description DESCRIPTION

The gdaladdo utility can be used to build or rebuild overview images for
most supported file formats with one of several downsampling algorithms.

<dl>
<dt> -r
{nearest (default),average,gauss,cubic,cubicspline,lanczos,average_mp,average_magphase,mode}:</dt><dd>
Select a resampling algorithm.</dd>
<dt> -b band:</dt><dd> (available from GDAL 1.10) Select an input band band for
overview generation. Band numbering starts from 1. Multiple -b switches may be used
to select a set of input bands to generate overviews.</dd>
<dt> -ro</dt>:<dd> (available from GDAL 1.6.0) open the dataset in read-only mode, in order to generate
external overview (for GeoTIFF especially). </dd>
<dt> -clean</dt>:<dd> (available from GDAL 1.7.0) remove all overviews. </dd>
<dt> -oo NAME=VALUE:</dt><dd>(starting with GDAL 2.0) Dataset open option (format specific)</dd>
<dt> filename:</dt><dd> The file to build overviews for (or whose overviews must be removed). </dd>
<dt> levels:</dt><dd> A list of integral overview levels to build. Ignored with -clean option.</dd>
</dl>

Mode (available from GDAL 1.6.0) selects the value which appears most often of all the sampled points.
average_mp is unsuitable for use.
Average_magphase averages complex data in mag/phase space.
Nearest and average are applicable to normal image data.
Nearest applies a nearest neighbour (simple sampling) resampler, while
average computes the average of all non-NODATA contributing pixels.
Cubic resampling (available from GDAL 1.7.0) applies a cubic convolution kernel.
Gauss resampling (available from GDAL 1.6.0) applies a Gaussian kernel before computing the overview,
which can lead to better results than simple averaging in e.g case of sharp edges
with high contrast or noisy patterns. The advised level values should be 2, 4, 8, ...
so that a 3x3 resampling Gaussian kernel is selected.
CubicSpline resampling (available from GDAL 2.0) applies a B-Spline convolution kernel.
Lanczos resampling (available from GDAL 2.0) applies a Lanczos windowed sinc convolution kernel.

gdaladdo will honour properly NODATA_VALUES tuples (special dataset metadata) so
that only a given RGB triplet (in case of a RGB image) will be considered as the
nodata value and not each value of the triplet independently per band.

Selecting a level value like 2 causes an overview level that is 1/2
the resolution (in each dimension) of the base layer to be computed. If
the file has existing overview levels at a level selected, those levels will
be recomputed and rewritten in place.

For internal GeoTIFF overviews (or external overviews in GeoTIFF format), note
that -clean does not shrink the file. A later run of gdaladdo with overview levels
will cause the file to be expanded, rather than reusing the space of the previously
deleted overviews. If you just want to change the resampling method on a file that
already has overviews computed, you don't need to clean the existing overviews.

Some format drivers do not support overviews at all.  Many format drivers
store overviews in a secondary file with the extension .ovr that is actually
in TIFF format.  By default, the GeoTIFF driver stores overviews internally to the file
operated on (if it is writable), unless the -ro flag is specified.

Most drivers also support an alternate overview format using Erdas Imagine
format.  To trigger this use the USE_RRD=YES configuration option.  This will
place the overviews in an associated .aux file suitable for direct use with
Imagine or ArcGIS as well as GDAL applications.  (e.g. --config USE_RRD YES)

\section gdaladdo_externalgtiffoverviews External overviews in GeoTIFF format

External overviews created in TIFF format may be compressed using the COMPRESS_OVERVIEW
configuration option.  All compression methods, supported by the GeoTIFF
driver, are available here. (e.g. --config COMPRESS_OVERVIEW DEFLATE).
The photometric interpretation can be set with --config PHOTOMETRIC_OVERVIEW {RGB,YCBCR,...},
and the interleaving with --config INTERLEAVE_OVERVIEW {PIXEL|BAND}.

For JPEG compressed external overviews, the JPEG quality can be set with
"--config JPEG_QUALITY_OVERVIEW value" (GDAL 1.7.0 or later).

For LZW or DEFLATE compressed external overviews, the predictor value can be set
with "--config PREDICTOR_OVERVIEW 1|2|3" (GDAL 1.8.0 or later).

To produce the smallest possible JPEG-In-TIFF overviews, you should use :
\verbatim
--config COMPRESS_OVERVIEW JPEG --config PHOTOMETRIC_OVERVIEW YCBCR --config INTERLEAVE_OVERVIEW PIXEL
\endverbatim

Starting with GDAL 1.7.0, external overviews can be created in the BigTIFF format by using
the BIGTIFF_OVERVIEW configuration option : --config BIGTIFF_OVERVIEW {IF_NEEDED|IF_SAFER|YES|NO}.
The default value is IF_NEEDED. The behaviour of this option is exactly the same as the BIGTIFF creation option
documented in the GeoTIFF driver documentation.
<ul>
 <li>YES forces BigTIFF.
 <li>NO forces classic TIFF.
 <li>IF_NEEDED will only create a BigTIFF if it is clearly needed (uncompressed, and overviews larger than 4GB).
 <li>IF_SAFER will create BigTIFF if the resulting file *might* exceed 4GB.
</ul>

See the documentation of the GeoTIFF driver for further explanations on all those options.

\section gdaladdo_api C API

Functionality of this utility can be done from C with GDALBuildOverviews().

\section gdaladdo_example EXAMPLE

\htmlonly
Example:
\endhtmlonly

Create overviews, embedded in the supplied TIFF file:

\verbatim
gdaladdo -r average abc.tif 2 4 8 16
\endverbatim

Create an external compressed GeoTIFF overview file from the ERDAS .IMG file:

\verbatim
gdaladdo -ro --config COMPRESS_OVERVIEW DEFLATE erdas.img 2 4 8 16
\endverbatim

Create an external JPEG-compressed GeoTIFF overview file from a 3-band RGB dataset
(if the dataset is a writable GeoTIFF, you also need to add the -ro option to
force the generation of external overview):

\verbatim
gdaladdo --config COMPRESS_OVERVIEW JPEG --config PHOTOMETRIC_OVERVIEW YCBCR
         --config INTERLEAVE_OVERVIEW PIXEL rgb_dataset.ext 2 4 8 16
\endverbatim

Create an Erdas Imagine format overviews for the indicated JPEG file:

\verbatim
gdaladdo --config USE_RRD YES airphoto.jpg 3 9 27 81
\endverbatim

\if man
\section gdaladdo_author AUTHORS
Frank Warmerdam <warmerdam@pobox.com>, Silke Reimer <silke@intevation.de>
\endif
*/

*******************************************************************************
/*!
\if man
\page gdaltindex
\else
\page gdaltindex gdaltindex
\endif

Builds a shapefile as a raster tileindex.

\section gdaltindex_synopsis SYNOPSIS

\verbatim
gdaltindex [-f format] [-tileindex field_name] [-write_absolute_path]
           [-skip_different_projection] [-t_srs target_srs]
           [-src_srs_name field_name] [-src_srs_format [AUTO|WKT|EPSG|PROJ]
           [-lyr_name name] index_file [gdal_file]*
\endverbatim

\section gdaltindex_description DESCRIPTION

This program builds a shapefile with a record for each input raster file,
an attribute containing the filename, and a polygon geometry outlining the
raster. This output is suitable for use with <a href="http://mapserver.org/">MapServer</a> as a raster
tileindex.

<dl>
<dt>-f format:</dt><dd> (GDAL >= 1.11)
The OGR format of the output tile index file. Default is ESRI Shapefile.
</dd>
<dt>-tileindex field_name:</dt>
<dd>The output field name to hold the file path/location to the indexed rasters. The default tile index field name is <code>location</code>.
</dd>
<dt>-write_absolute_path:</dt>
<dd>The absolute path to the raster files is stored in the tile index file. By default the raster filenames will be put in the file exactly as they are specified on the command line.
</dd>
<dt>-skip_different_projection:</dt>
<dd>Only files with same projection as files already inserted in the tileindex will be inserted (unless <code>-t_srs</code> is specified). Default does not check projection and accepts all inputs.
</dd>
<dt>-t_srs target_srs:</dt>
<dd>Geometries of input files will be transformed to the desired target coordinate reference system. Using this option generates files that are not compatible with MapServer &lt; 6.4. Default creates simple rectangular polygons in the same coordinate reference system as the input rasters.
</dd>
<dt>-src_srs_name field_name:</dt><dd> (GDAL >= 1.11)
The name of the field to store the SRS of each tile. This field name can be used as the value of the TILESRS keyword in MapServer &gt;= 6.4.
</dd>
<dt>-src_srs_format type:</dt><dd> (GDAL >= 1.11)
The format in which the SRS of each tile must be written. Types can be AUTO, WKT, EPSG, PROJ.
</dd>
<dt>-lyr_name name:</dt>
<dd>Layer name to create/append to in the output tile index file.
</dd>
<dt>index_file:</dt>
<dd>The name of the output file to create/append to. The default shapefile will be created if it doesn't already exist, otherwise it will append to the existing file.
</dd>
<dt>gdal_file:</dt>
<dd>The input GDAL raster files, can be multiple files separated by spaces. Wildcards my also be used. Stores the file locations in the same style as specified here, unless <code>-write_absolute_path</code> option is also used.
</dd>
</dl>

\section gdaltindex_example EXAMPLES

\htmlonly
Examples:
\endhtmlonly

Produce a shapefile (<code>doq_index.shp</code>) with a record for every
image that the utility found in the <code>doq</code> folder. Each record holds
information that points to the location of the image and also a bounding rectangle
shape showing the bounds of the image:

\verbatim
gdaltindex doq_index.shp doq/*.tif
\endverbatim

The <code>-t_srs</code> option can also be used to transform all input rasters
into the same output projection:

\verbatim
gdaltindex -t_srs EPSG:4326 -src_srs_name src_srs tile_index_mixed_srs.shp *.tif
\endverbatim

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

*******************************************************************************
/*!
\if man
\page gdalbuildvrt
\else
\page gdalbuildvrt gdalbuildvrt
\endif

Builds a VRT from a list of datasets.

\section gdalbuildvrt_synopsis SYNOPSIS

\verbatim
gdalbuildvrt [-tileindex field_name]
             [-resolution {highest|lowest|average|user}]
             [-te xmin ymin xmax ymax] [-tr xres yres] [-tap]
             [-separate] [-b band]* [-sd subdataset]
             [-allow_projection_difference] [-q]
             [-addalpha] [-hidenodata]
             [-srcnodata "value [value...]"] [-vrtnodata "value [value...]"]
             [-a_srs srs_def]
             [-r {nearest,bilinear,cubic,cubicspline,lanczos,average,mode}]
             [-oo NAME=VALUE]*
             [-input_file_list my_list.txt] [-overwrite] output.vrt [gdalfile]*
\endverbatim

\section gdalbuildvrt_description DESCRIPTION

This program builds a VRT (Virtual Dataset) that is a mosaic of the list of
input GDAL datasets. The list of input GDAL datasets can be specified at the end
of the command line, or put in a text file (one filename per line) for very long lists,
or it can be a MapServer tileindex (see \ref gdaltindex utility). In the later case, all
entries in the tile index will be added to the VRT.

With -separate, each files goes into a separate band in the VRT band. Otherwise,
the files are considered as tiles of a larger mosaic and the VRT file has as many bands as one
of the input files.

If one GDAL dataset is made of several subdatasets and has 0 raster bands,
all the subdatasets will be added to the VRT rather than the dataset itself.

gdalbuildvrt does some amount of checks to assure that all files that will be put
in the resulting VRT have similar characteristics : number of bands, projection, color
interpretation... If not, files that do not match the common characteristics will be skipped.
(This is only true in the default mode, and not when using the -separate option)

If there is some amount of spatial overlapping between files, the order of files
appearing in the list of source matter: files that are listed at the end are the ones
from which the content will be fetched. Note that nodata will be taken into account
to potentially fetch data from less prioritary datasets, but currently, alpha channel
is not taken into account to do alpha compositing (so a source with alpha=0
appearing on top of another source will override is content). This might be
changed in later versions.

This utility is somehow equivalent to the gdal_vrtmerge.py utility and is build by default
in GDAL 1.6.1.

<dl>

<dt> -tileindex:</dt><dd>
Use the specified value as the tile index field, instead of the default value with is 'location'.
</dd>

<dt> -resolution {highest|lowest|average|user}:</dt><dd>
In case the resolution of all input files is not the same, the -resolution flag
enables the user to control the way the output resolution is computed. 'average' is the default.
'highest' will pick the smallest values of pixel dimensions within the set of source rasters.
'lowest' will pick the largest values of pixel dimensions within the set of source rasters.
'average' will compute an average of pixel dimensions within the set of source rasters.
'user' is new in GDAL 1.7.0 and must be used in combination with the -tr option to specify the target resolution.
</dd>

<dt> -tr xres yres :</dt><dd> (starting with GDAL 1.7.0)
set target resolution. The values must be expressed in georeferenced units.
Both must be positive values. Specifying those values is of course incompatible with
highest|lowest|average values for -resolution option.
</dd>

<dt> -tap:</dt><dd> (GDAL >= 1.8.0) (target aligned pixels) align
the coordinates of the extent of the output file to the values of the -tr,
such that the aligned extent includes the minimum extent.</dd>

<dt> -te xmin ymin xmax ymax :</dt><dd> (starting with GDAL 1.7.0)
set georeferenced extents of VRT file. The values must be expressed in georeferenced units.
If not specified, the extent of the VRT is the minimum bounding box of the set of source rasters.
</dd>

<dt> -addalpha:</dt><dd> (starting with GDAL 1.7.0)
Adds an alpha mask band to the VRT when the source raster have none. Mainly useful for RGB sources (or grey-level sources).
The alpha band is filled on-the-fly with the value 0 in areas without any source raster, and with value
255 in areas with source raster. The effect is that a RGBA viewer will render
the areas without source rasters as transparent and areas with source rasters as opaque.
This option is not compatible with -separate.</dd>

<dt> -hidenodata:</dt><dd> (starting with GDAL 1.7.0)
Even if any band contains nodata value, giving this option makes the VRT band
not report the NoData. Useful when you want to control the background color of
the dataset. By using along with the -addalpha option, you can prepare a
dataset which doesn't report nodata value but is transparent in areas with no
data.</dd>

<dt> -srcnodata value [value...]:</dt><dd> (starting with GDAL 1.7.0)
Set nodata values for input bands (different values can be supplied for each band). If
more than one value is supplied all values should be quoted to keep them
together as a single operating system argument. If the option is not specified, the
intrinsic nodata settings on the source datasets will be used (if they exist). The value set by this option
is written in the NODATA element of each ComplexSource element. Use a value of
<tt>None</tt> to ignore intrinsic nodata settings on the source datasets.</dd>

<dt> -b band:</dt><dd>(GDAL >= 1.10.0)
Select an input band to be processed. Bands are numbered from 1.
If input bands not set all bands will be added to vrt.
Multiple -b switches may be used to select a set of input bands.</dd>

<dt> -sd subdataset</dt><dd> (GDAL >= 1.10.0) If the input
dataset contains several subdatasets use a subdataset with the specified
number (starting from 1). This is an alternative of giving the full subdataset
name as an input.</dd>

<dt> -vrtnodata value [value...]:</dt><dd> (starting with GDAL 1.7.0)
Set nodata values at the VRT band level (different values can be supplied for each band). If more
than one value is supplied all values should be quoted to keep them together
as a single operating system argument. If the option is not specified,
intrinsic nodata settings on the first dataset will be used (if they exist). The value set by this option
is written in the NoDataValue element of each VRTRasterBand element. Use a value of
<tt>None</tt> to ignore intrinsic nodata settings on the source datasets.</dd>

<dt> -separate:</dt><dd> (starting with GDAL 1.7.0)
Place each input file into a separate band. In that case, only the first
band of each dataset will be placed into a new band. Contrary to the default mode, it is not
required that all bands have the same datatype.
</dd>

<dt> -allow_projection_difference:</dt><dd> (starting with GDAL 1.7.0)
When this option is specified, the utility will accept to make a VRT even if the input datasets have
not the same projection. Note: this does not mean that they will be reprojected. Their projection will
just be ignored.
</dd>

<dt> -a_srs srs_def:</dt><dd> (starting with GDAL 1.10)
Override the projection for the output file. The srs_def may be any of the usual GDAL/OGR forms,
complete WKT, PROJ.4, EPSG:n or a file containing the WKT. </dd>

<dt> -r
{nearest (default),bilinear,cubic,cubicspline,lanczos,average,mode}:</dt><dd>
(GDAL &gt;= 2.0) Select a resampling algorithm.</dd>

<dt> -oo NAME=VALUE:</dt><dd>(starting with GDAL 2.2)
Dataset open option (format specific)</dd>

<dt> -input_file_list:</dt><dd>
To specify a text file with an input filename on each line
</dd>

<dt> -q:</dt><dd> (starting with GDAL 1.7.0)
To disable the progress bar on the console
</dd>

<dt> -overwrite:</dt><dd>Overwrite the VRT if it already exists.</dd>

</dl>

\section gdalbuildvrt_example EXAMPLE

\htmlonly
Example:
\endhtmlonly

Make a virtual mosaic from all TIFF files contained in a directory :
\verbatim
gdalbuildvrt doq_index.vrt doq/*.tif
\endverbatim

Make a virtual mosaic from files whose name is specified in a text file :
\verbatim
gdalbuildvrt -input_file_list my_list.txt doq_index.vrt
\endverbatim

Make a RGB virtual mosaic from 3 single-band input files :
\verbatim
gdalbuildvrt -separate rgb.vrt red.tif green.tif blue.tif
\endverbatim

Make a virtual mosaic with blue background colour (RGB: 0 0 255) :
\verbatim
gdalbuildvrt -hidenodata -vrtnodata "0 0 255" doq_index.vrt doq/*.tif
\endverbatim

\if man
\section gdalbuildvrt_author AUTHOR
Even Rouault <even.rouault@mines-paris.org>
\endif
*/

*******************************************************************************
/*!
\if man
\page gdal_contour
\else
\page gdal_contour gdal_contour
\endif

Builds vector contour lines from a raster elevation model.

\section gdal_contour_synopsis SYNOPSIS

\verbatim
Usage: gdal_contour [-b <band>] [-a <attribute_name>] [-3d] [-inodata]
 [-snodata n] [-i <interval>]
 [-f <formatname>] [[-dsco NAME=VALUE] ...] [[-lco NAME=VALUE] ...]
 [-off <offset>] [-fl <level> <level>...]
 [-nln <outlayername>]
 <src_filename> <dst_filename>
\endverbatim

\section gdal_contour_description DESCRIPTION

This program generates a vector contour file from the input raster elevation
model (DEM).

Starting from version 1.7 the contour line-strings will be oriented
consistently. The high side will be on the right, i.e. a line string goes
clockwise around a top.

<dl>

<dt> -b band:</dt><dd> picks a particular band to get the DEM from. Defaults to band 1.</dd>

<dt> -a name:</dt><dd>provides a name for the attribute in which to put the elevation. If not provided no elevation attribute is attached. </dd>
<dt> -3d:</dt> <dd>
 Force production of 3D vectors instead of 2D. Includes elevation at
 every vertex.</dd>

<dt> -inodata:</dt> <dd> Ignore any nodata value implied in the dataset - treat all values as valid.</dd>

<dt> -snodata value:</dt><dd>
 Input pixel value to treat as "nodata". </dd>

<dt> -f format:</dt> <dd>
create output in a particular format, default is shapefiles.</dd>

<dt> -dsco NAME=VALUE:</dt><dd> Dataset creation option (format specific)</dd>
<dt> -lco NAME=VALUE:</dt><dd> Layer creation option (format specific)</dd>

<dt> -i interval:</dt><dd>
 elevation interval between contours.</dd>

<dt> -off offset:</dt><dd>
 Offset from zero relative to which to interpret intervals.</dd>

<dt> -fl level:</dt>
<dd> Name one or more "fixed levels" to extract.</dd>
<dt> -nln outlayername:</dt>
<dd> Provide a name for the output vector layer. Defaults to "contour".</dd>
</dl>

\section gdal_contour_api C API

Functionality of this utility can be done from C with GDALContourGenerate().

\section gdal_contour_example EXAMPLE

This would create 10meter contours from the DEM data in dem.tif and produce
a shapefile in contour.shp/shx/dbf with the contour elevations in the "elev"
attribute.

\verbatim
gdal_contour -a elev dem.tif contour.shp -i 10.0
\endverbatim

\if man
\section gdal_contour_author AUTHORS
Frank Warmerdam <warmerdam@pobox.com>, Silke Reimer <silke@intevation.de>
\endif
*/

*******************************************************************************
/*!
\if man
\page gdal_rasterize
\else
\page gdal_rasterize gdal_rasterize
\endif

Burns vector geometries into a raster.

\section gdal_rasterize_synopsis SYNOPSIS

\verbatim
Usage: gdal_rasterize [-b band]* [-i] [-at]
 {[-burn value]* | [-a attribute_name] | [-3d]} [-add]
 [-l layername]* [-where expression] [-sql select_statement]
 [-dialect dialect] [-of format] [-a_srs srs_def]
 [-co "NAME=VALUE"]* [-a_nodata value] [-init value]*
 [-te xmin ymin xmax ymax] [-tr xres yres] [-tap] [-ts width height]
 [-ot {Byte/Int16/UInt16/UInt32/Int32/Float32/Float64/
 CInt16/CInt32/CFloat32/CFloat64}] [-q]
 <src_datasource> <dst_filename>
\endverbatim

\section gdal_rasterize_description DESCRIPTION

This program burns vector geometries (points, lines, and polygons) into the
raster band(s) of a raster image.  Vectors are read from OGR supported vector
formats.

Note that on the fly reprojection of vector data to the coordinate system of the
raster data is only supported since GDAL 2.1.0.

Since GDAL 1.8.0, the target GDAL file can be created by gdal_rasterize. Either
the -tr or -ts option must be used in that case.

<dl>
<dt> -b band: </dt><dd>
The band(s) to burn values into. Multiple -b arguments may be used to burn
into a list of bands. The default is to burn into band 1.</dd>

<dt> -i: </dt><dd>
Invert rasterization. Burn the fixed burn value, or the burn value associated
with the first feature into all parts of the image not inside the
provided polygon.</dd>

<dt> -at: </dt><dd>
Enables the ALL_TOUCHED rasterization option so that all pixels touched
by lines or polygons will be updated, not just those on the line render path,
or whose center point is within the polygon. Defaults to disabled for normal
rendering rules.</dd>

<dt> -burn value: </dt><dd>
A fixed value to burn into a band for all objects. A list of -burn options
can be supplied, one per band being written to.</dd>

<dt> -a attribute_name: </dt><dd>
Identifies an attribute field on the features to be used for a burn-in value.
The value will be burned into all output bands.</dd>

<dt> -3d: </dt><dd>
Indicates that a burn value should be extracted from the "Z" values of the
feature. As of now, only points and lines are drawn in 3D.</dd>

<dt> -add: </dt><dd>
Instead of burning a new value, this adds the new value to the existing raster.
Suitable for heatmaps for instance.</dd>

<dt> -l layername: </dt><dd>
Indicates the layer(s) from the datasource that will be used for input
features. May be specified multiple times, but at least one layer name or a
-sql option must be specified.</dd>

<dt> -where expression: </dt><dd>
An optional SQL WHERE style query expression to be applied to select features
to burn in from the input layer(s). </dd>

<dt> -sql select_statement: </dt><dd>
An SQL statement to be evaluated against the datasource to produce a
virtual layer of features to be burned in.</dd>

<dt> -dialect dialect: </dt><dd> (GDAL >= 2.1.0)
SQL dialect. In some cases can be used to use (unoptimized) OGR SQL instead of
the native SQL of an RDBMS by passing OGRSQL. Starting with GDAL 1.10, the
"SQLITE" dialect can also be used with any datasource.</dd>

<dt> -of format:</dt><dd> (GDAL >= 1.8.0)
Select the output format. The default is GeoTIFF (GTiff). Use the short format
name.</dd>

<dt> -a_nodata value:</dt><dd> (GDAL >= 1.8.0)
Assign a specified nodata value to output bands.</dd>

<dt> -init value:</dt><dd> (GDAL >= 1.8.0)
Pre-initialize the output image bands with these values. However, it is not
marked as the nodata value in the output file. If only one value is given, the
same value is used in all the bands.</dd>

<dt> -a_srs srs_def:</dt><dd> (GDAL >= 1.8.0)
Override the projection for the output file. If not specified, the projection of
the input vector file will be used if available. If incompatible projections
between input and output files, no attempt will be made to reproject features.
The srs_def may be any of the usual GDAL/OGR forms, complete WKT, PROJ.4,
EPSG:n or a file containing the WKT. </dd>

<dt> -co "NAME=VALUE":</dt><dd> (GDAL >= 1.8.0)
Passes a creation option to the output format driver. Multiple -co
options may be listed. See <a class="el"
href="formats_list.html" title="GDAL Raster Formats">format specific
documentation for legal creation options for each format</a>.</dd>

<dt> -te xmin ymin xmax ymax :</dt><dd> (GDAL >= 1.8.0)
Set georeferenced extents. The values must be expressed in georeferenced units.
If not specified, the extent of the output file will be the extent of the vector
layers. </dd>

<dt> -tr xres yres :</dt><dd> (GDAL >= 1.8.0)
Set target resolution. The values must be expressed in georeferenced units.
Both must be positive values.
</dd>

<dt> -tap:</dt><dd> (GDAL >= 1.8.0) (target aligned pixels) Align
the coordinates of the extent of the output file to the values of the -tr,
such that the aligned extent includes the minimum extent.</dd>

<dt> -ts width height:</dt><dd> (GDAL >= 1.8.0)
Set output file size in pixels and lines. Note that -ts cannot be used with
-tr</dd>

<dt> -ot type:</dt><dd> (GDAL >= 1.8.0)
For the output bands to be of the indicated data type. Defaults to Float64</dd>

<dt> -q:</dt><dd> (GDAL >= 1.8.0) Suppress progress monitor and other
non-error output.</dd>

<dt> src_datasource: </dt><dd>
Any OGR supported readable datasource.</dd>

<dt> dst_filename: </dt><dd>
The GDAL supported output file. Must support update mode access.
Before GDAL 1.8.0, gdal_rasterize could not create new output files.</dd>

</dl>

\section gdal_rasterize_api C API

Starting with GDAL 2.1, this utility is also callable from C with GDALRasterize().

\section gdal_rasterize_example EXAMPLE

The following would burn all polygons from mask.shp into the RGB TIFF
file work.tif with the color red (RGB = 255,0,0).

\verbatim
gdal_rasterize -b 1 -b 2 -b 3 -burn 255 -burn 0 -burn 0 -l mask mask.shp work.tif
\endverbatim

The following would burn all "class A" buildings into the output elevation
file, pulling the top elevation from the ROOF_H attribute.

\verbatim
gdal_rasterize -a ROOF_H -where 'class="A"' -l footprints footprints.shp city_dem.tif
\endverbatim

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

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

Convert a 24bit RGB image to 8bit paletted.

\section rgb2pct_synopsis SYNOPSIS

\verbatim
rgb2pct.py [-n colors | -pct palette_file] [-of format] source_file dest_file
\endverbatim

\section rgb2pct_description DESCRIPTION

This utility will compute an optimal pseudo-color table for a given RGB image
using a median cut algorithm on a downsampled RGB histogram.   Then it
converts the image into a pseudo-colored image using the color table.
This conversion utilizes Floyd-Steinberg dithering (error diffusion) to
maximize output image visual quality.

<dl>
<dt> -n colors:</dt><dd> Select the number of colors in the generated
color table. Defaults to 256. Must be between 2 and 256. </dd>
<dt> -pct palette_file:</dt><dd> Extract the color table from
palette_file instead of computing it. Can be used to have a consistent
color table for multiple files. The palette_file must be a raster file
in a GDAL supported format with a palette.</dd>
<dt> -of format:</dt><dd> Format to generated (defaults to GeoTIFF). Same
semantics as the -of flag for gdal_translate. Only output formats
supporting pseudo-color tables should be used. </dd>
<dt> source_file:</dt><dd> The input RGB file. </dd>
<dt> dest_file:</dt><dd> The output pseudo-colored file that will be
created.</dd>
</dl>

NOTE: rgb2pct.py is a Python script, and will only work if GDAL was built
with Python support.

\section rgb2pct_example EXAMPLE

If it is desired to hand create the palette, likely the simplest text format
is the GDAL VRT format.  In the following example a VRT was created in a
text editor with a small 4 color palette with the RGBA colors 238/238/238/255,
237/237/237/255, 236/236/236/255 and 229/229/229/255.

\verbatim
% rgb2pct.py -pct palette.vrt rgb.tif pseudo-colored.tif
% more < palette.vrt
<VRTDataset rasterXSize="226" rasterYSize="271">
 <VRTRasterBand dataType="Byte" band="1">
 <ColorInterp>Palette</ColorInterp>
 <ColorTable>
 <Entry c1="238" c2="238" c3="238" c4="255"/>
 <Entry c1="237" c2="237" c3="237" c4="255"/>
 <Entry c1="236" c2="236" c3="236" c4="255"/>
 <Entry c1="229" c2="229" c3="229" c4="255"/>
 </ColorTable>
 </VRTRasterBand>
</VRTDataset>
\endverbatim

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

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

Convert an 8bit paletted image to 24bit RGB.

\section pct2rgb_synopsis SYNOPSIS

\htmlonly
Usage:
\endhtmlonly

\verbatim
pct2rgb.py [-of format] [-b band] [-rgba] source_file dest_file
\endverbatim

\section pct2rgb_description DESCRIPTION

This utility will convert a pseudo-color band on the input file into an output
RGB file of the desired format.

<dl>
<dt> -of format:</dt><dd> Format to generated (defaults to GeoTIFF).</dd>
<dt> -b band:</dt><dd>
Band to convert to RGB, defaults to 1.</dd>
<dt> -rgba:</dt><dd> Generate a RGBA file (instead of a RGB file by default).</dd>
<dt> source_file:</dt><dd> The input file. </dd>
<dt> dest_file:</dt><dd> The output RGB file that will be
created.</dd>
</dl>

NOTE: pct2rgb.py is a Python script, and will only work if GDAL was built
with Python support.

The new '-expand rgb|rgba' option of gdal_translate obsoletes that utility.

\if man
\section pct2rgb_author AUTHORS
Frank Warmerdam <warmerdam@pobox.com>, Silke Reimer <silke@intevation.de>
\endif
*/

*******************************************************************************
/*!
\if man
\page gdaltransform
\else
\page gdaltransform gdaltransform
\endif

Transforms coordinates.

\section gdaltransform_synopsis SYNOPSIS

\verbatim
gdaltransform [--help-general]
    [-i] [-s_srs srs_def] [-t_srs srs_def] [-to "NAME=VALUE"]
    [-order n] [-tps] [-rpc] [-geoloc]
    [-gcp pixel line easting northing [elevation]]* [-output_xy]
    [srcfile [dstfile]]
\endverbatim

\section gdaltransform_description DESCRIPTION

The gdaltransform utility reprojects a list of coordinates into any supported
projection,including  GCP-based transformations.

<dl>
<dt> -s_srs srs def:</dt><dd> source spatial reference set.
The coordinate systems that can be passed are anything supported by the
OGRSpatialReference.SetFromUserInput() call, which includes EPSG PCS and GCSes
(i.e. EPSG:4296), PROJ.4 declarations (as above), or the name of a .prj file
containing well known text.</dd>
<dt> -t_srs srs_def:</dt><dd> target spatial reference set.
The coordinate systems that can be passed are anything supported by the
OGRSpatialReference.SetFromUserInput() call, which includes EPSG PCS and GCSes
(i.e. EPSG:4296), PROJ.4 declarations (as above), or the name of a .prj file
containing well known text.</dd>
<dt> -to NAME=VALUE:</dt><dd> set a transformer option suitable
to pass to GDALCreateGenImgProjTransformer2(). </dd>
<dt> -order n:</dt><dd> order of polynomial used for warping
(1 to 3). The default is to select a polynomial order based on the number of
GCPs.</dd>
<dt> -tps:</dt><dd>Force use of thin plate spline transformer based on
available GCPs.</dd>
<dt> -rpc:</dt> <dd>Force use of RPCs.</dd>
<dt> -geoloc:</dt><dd>Force use of Geolocation Arrays.</dd>
<dt> -i</dt><dd>Inverse transformation: from destination to source.</dd>
<dt> -gcppixel line easting northing [elevation]:</dt> <dd>Provide a GCP to be used for transformation (generally three or more are required)</dd>
<dt> -output_xy:</dt> <dd>(GDAL >= 2.0) Restrict output to "x y" instead of "x y z"</dd>
<dt> srcfile:</dt><dd> File with source projection definition or GCP's. If
 not given, source projection is read from the command-line -s_srs or -gcp parameters </dd>
<dt> dstfile:</dt><dd> File with destination projection definition. </dd>
</dl>

Coordinates are read as pairs (or triples) of numbers per line from standard
input, transformed, and written out to standard output in the same way. All
transformations offered by gdalwarp are handled, including gcp-based ones.

Note that input and output must always be in decimal form.  There is currently
no support for DMS input or output.

If an input image file is provided, input is in pixel/line coordinates on that
image.  If an output file is provided, output is in pixel/line coordinates
on that image.

\section gdaltransform_example Reprojection Example

Simple reprojection from one projected coordinate system to another:

\verbatim
gdaltransform -s_srs EPSG:28992 -t_srs EPSG:31370
177502 311865
\endverbatim

Produces the following output in meters in the "Belge 1972 / Belgian Lambert
72" projection:

\verbatim
244510.77404604 166154.532871342 -1046.79270555763
\endverbatim

\section gdaltransform_rpc_example Image RPC Example

The following command requests an RPC based transformation using the RPC
model associated with the named file.  Because the -i (inverse) flag is
used, the transformation is from output georeferenced (WGS84) coordinates
back to image coordinates.

\verbatim
gdaltransform -i -rpc 06OCT20025052-P2AS-005553965230_01_P001.TIF
125.67206 39.85307 50
\endverbatim

Produces this output measured in pixels and lines on the image:
\verbatim
3499.49282422381 2910.83892848414 50
\endverbatim

\if man
\section gdaltransform_author AUTHORS
Frank Warmerdam <warmerdam@pobox.com>, Jan Hartmann <j.l.h.hartmann@uva.nl>
\endif
*/
*******************************************************************************
/*!
\if man
\page nearblack
\else
\page nearblack nearblack
\endif

Convert nearly black/white borders to black.

\section nearblack_synopsis SYNOPSIS

\verbatim
nearblack [-of format] [-white | [-color c1,c2,c3...cn]*] [-near dist] [-nb non_black_pixels]
          [-setalpha] [-setmask] [-o outfile] [-q]  [-co "NAME=VALUE"]* infile
\endverbatim

\section nearblack_description DESCRIPTION

This utility will scan an image and try to set all pixels that are nearly or exactly
black, white or one or more custom colors around the collar to black or white.  This
is often used to "fix up" lossy compressed air photos so that color pixels
can be treated as transparent when mosaicing.

<dl>
<dt> -o outfile:</dt><dd> The name of the output file to be
created. Newly created files are created with the HFA driver by default
(Erdas Imagine - .img)</dd>
<dt> -of format:</dt><dd> (GDAL 1.8.0 or later) Select the output format.
Use the short format name (GTiff for GeoTIFF for example).</dd>
<dt> -co "NAME=VALUE":</dt><dd> (GDAL 1.8.0 or later) Passes a creation option to the
output format driver. Multiple -co options may be listed. See <a class="el"
href="formats_list.html" title="GDAL Raster Formats">format specific
documentation for legal creation options for each format</a>. Only valid when creating a new file</dd>
<dt> -white:</dt><dd>
Search for nearly white (255) pixels instead of nearly black pixels.
</dd>
<dt> -color c1,c2,c3...cn:</dt><dd> (GDAL >= 1.9.0)
Search for pixels near the specified color. May be specified multiple times.
When -color is specified, the pixels that are considered as the collar are set to 0.
</dd>
<dt> -near dist:</dt><dd>
Select how far from black, white or custom colors the pixel values can be and still considered near black, white or custom color. Defaults to 15.
</dd>
<dt> -nb non_black_pixels:</dt><dd>
number of non-black pixels that can be encountered before the giving up search inwards. Defaults to 2.
</dd>
<dt> -setalpha:</dt><dd> (GDAL 1.8.0 or later)
Adds an alpha band if the output file is specified and the input file has 3 bands,
or sets the alpha band of the output file if it is specified and the input file has 4 bands,
or sets the alpha band of the input file if it has 4 bands and no output file is specified.
The alpha band is set to 0 in the image collar and to 255 elsewhere.
</dd>
<dt> -setmask:</dt><dd> (GDAL 1.8.0 or later)
Adds a mask band to the output file,
or adds a mask band to the input file if it does not already have one and no output file is specified.
The mask band is set to 0 in the image collar and to 255 elsewhere.
</dd>
<dt> -q:</dt><dd> (GDAL 1.8.0 or later) Suppress progress monitor and other non-error
output.</dd>
<dt> infile:</dt><dd>
The input file. Any GDAL supported format, any number of bands, normally 8bit
Byte bands.
</dd>
</dl>

The algorithm processes the image one scanline at a time.  A scan "in" is done
from either end setting pixels to black or white until at least
"non_black_pixels" pixels that are more than "dist" gray levels away from
black, white or custom colors have been encountered at which point the scan stops.  The nearly
black, white or custom color pixels are set to black or white. The algorithm also scans from
top to bottom and from bottom to top to identify indentations in the top or bottom.

The processing is all done in 8bit (Bytes).

If the output file is omitted, the processed results will be written back
to the input file - which must support update.

\section nearblack_api C API

Starting with GDAL 2.1, this utility is also callable from C with GDALNearblack().

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

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

Mosaics a set of images.

\section gdal_merge_synopsis SYNOPSIS

\verbatim
gdal_merge.py [-o out_filename] [-of out_format] [-co NAME=VALUE]*
              [-ps pixelsize_x pixelsize_y] [-tap] [-separate] [-q] [-v] [-pct]
              [-ul_lr ulx uly lrx lry] [-init "value [value...]"]
              [-n nodata_value] [-a_nodata output_nodata_value]
              [-ot datatype] [-createonly] input_files
\endverbatim

\section gdal_merge_description DESCRIPTION

This utility will automatically mosaic a set of images.  All the images must
be in the same coordinate system and have a matching number of bands, but
they may be overlapping, and at different resolutions. In areas of overlap,
the last image will be copied over earlier ones.

<dl>
<dt> -o out_filename:</dt><dd> The name of the output file,
which will be created if it does not already exist (defaults to "out.tif").</dd>
<dt> -of format:</dt><dd>
Output format, defaults to GeoTIFF (GTiff).
</dd>
<dt> -co NAME=VALUE:</dt><dd>
Creation option for output file. Multiple options can be specified.
See <a class="el"
href="formats_list.html" title="GDAL Raster Formats">format specific
documentation for legal creation options for each format</a>
</dd>
<dt> -ot datatype:</dt><dd>
Force the output image bands to have a specific type. Use type names (i.e. Byte, Int16,...)
</dd>
<dt> -ps pixelsize_x pixelsize_y:</dt><dd> Pixel size to be used for the
output file. If not specified the resolution of the first input file will
be used.</dd>

<dt> -ul_lr ulx uly lrx lry:</dt><dd> The extents of the output file.
If not specified the aggregate extents of all input files will be
used.</dd>
<dt>
<dt> -v:</dt><dd> Generate verbose output of mosaicing operations as they are done.</dd>
<dt> -separate:</dt><dd>
Place each input file into a separate band.
</dd>
<dt> -pct:</dt><dd>
Grab a pseudo-color table from the first input image, and use it for the output.
Merging pseudo-colored images this way assumes that all input files use the same
color table.
</dd>
<dt> -n nodata_value:</dt><dd>
Ignore pixels from files being merged in with this pixel value.
</dd>
<dt> -a_nodata output_nodata_value:</dt><dd>
(GDAL >= 1.9.0) Assign a specified nodata value to output bands.</dd>
<dt> -init "value(s)":</dt><dd>
Pre-initialize the output image bands with these values. However, it is not
marked as the nodata value in the output file. If only one value is given, the
same value is used in all the bands.
</dd>
<dt> -createonly:</dt><dd>
The output file is created (and potentially pre-initialized) but no input
image data is copied into it.
</dd>
</dl>

NOTE: gdal_merge.py is a Python script, and will only work if GDAL was built
with Python support.

\section gdal_merge_example EXAMPLE

Create an image with the pixels in all bands initialized to 255.

\verbatim
% gdal_merge.py -init 255 -o out.tif in1.tif in2.tif
\endverbatim

Create an RGB image that shows blue in pixels with no data. The first two bands
will be initialized to 0 and the third band will be initialized to 255.

\verbatim
% gdal_merge.py -init "0 0 255" -o out.tif in1.tif in2.tif
\endverbatim

\if man
\section gdal_merge_author AUTHORS
Frank Warmerdam <warmerdam@pobox.com>, Silke Reimer <silke@intevation.de>
\endif
*/

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

Generates directory with TMS tiles, KMLs and simple web viewers.

\section gdal2tiles_synopsis SYNOPSIS

\verbatim
gdal2tiles.py [-p profile] [-r resampling] [-s srs] [-z zoom]
              [-e] [-a nodata] [-v] [-q] [-h] [-k] [-n] [-u url]
              [-w webviewer] [-t title] [-c copyright]
              [-g googlekey] [-b bingkey] input_file [output_dir]
\endverbatim

\section gdal2tiles_description DESCRIPTION

This utility generates a directory with small tiles and metadata, following
the OSGeo Tile Map Service Specification. Simple web pages with viewers based on
Google Maps, OpenLayers and Leaflet are generated as well - so anybody can comfortably
explore your maps on-line and you do not need to install or configure any
special software (like MapServer) and the map displays very fast in the
web browser. You only need to upload the generated directory onto a web server.

GDAL2Tiles also creates the necessary metadata for Google Earth (KML
SuperOverlay), in case the supplied map uses EPSG:4326 projection.

World files and embedded georeferencing is used during tile generation, but you
can publish a picture without proper georeferencing too.

<dl>
<dt> -p PROFILE, --profile=PROFILE:</dt>
 <dd>Tile cutting profile (mercator,geodetic,raster) - default 'mercator' (Google Maps compatible).</dd>
<dt> -r RESAMPLING, --resampling=RESAMPLING:</dt>
 <dd>Resampling method (average,near,bilinear,cubic,cubicspline,lanczos,antialias) - default 'average'.</dd>
<dt> -s SRS, --s_srs=SRS:</dt>
 <dd>The spatial reference system used for the source input data.</dd>
<dt> -z ZOOM, --zoom=ZOOM:</dt>
 <dd>Zoom levels to render (format:'2-5' or '10').</dd>
<dt> -e, --resume:</dt>
 <dd>Resume mode. Generate only missing files.</dd>
<dt> -a NODATA, --srcnodata=NODATA:</dt>
 <dd>NODATA transparency value to assign to the input data.</dd>
<dt> -v, --verbose</dt>
 <dd>Generate verbose output of tile generation.</dd>
<dt> -q, --quiet</dt>
 <dd>Disable messages and status to stdout (GDAL &gt;= 2.1).</dd>
<dt> -h, --help</dt>
 <dd>Show help message and exit.</dd>
<dt> \-\-version</dt>
 <dd>Show program's version number and exit.</dd>
</dl>

KML (Google Earth) options:

Options for generated Google Earth SuperOverlay metadata
<dl>
<dt> -k, --force-kml</dt>
 <dd>Generate KML for Google Earth - default for 'geodetic' profile and 'raster' in EPSG:4326. For a dataset with different projection use with caution!</dd>
<dt> -n, --no-kml:</dt>
 <dd>Avoid automatic generation of KML files for EPSG:4326.</dd>
<dt> -u URL, --url=URL:</dt>
 <dd>URL address where the generated tiles are going to be published.</dd>
</dl>

Web viewer options:

Options for generated HTML viewers a la Google Maps
<dl>
<dt> -w WEBVIEWER, --webviewer=WEBVIEWER:</dt>
 <dd>Web viewer to generate (all,google,openlayers,leaflet,none) - default 'all'.</dd>
<dt> -t TITLE, --title=TITLE:</dt>
 <dd>Title of the map.</dd>
<dt> -c COPYRIGHT, --copyright=COPYRIGHT:</dt>
 <dd>Copyright for the map.</dd>
<dt> -g GOOGLEKEY, --googlekey=GOOGLEKEY:</dt>
 <dd>Google Maps API key from http://code.google.com/apis/maps/signup.html.</dd>
<dt> -b BINGKEY, --bingkey=BINGKEY:</dt>
 <dd>Bing Maps API key from https://www.bingmapsportal.com/</dd>

</dl>

NOTE: gdal2tiles.py is a Python script that needs to be run against "new generation" Python GDAL binding.

\if man
\section gdal2tiles_author AUTHORS
Klokan Petr Pridal <klokan@klokan.cz> as a Google SoC 2007 Project.
\endif
*/

*******************************************************************************
/*!
\if man
\page gdal-config
\else
\page gdal-config gdal-config
\endif

Determines various information about a GDAL installation.

\section gdal_config_synopsis SYNOPSIS

\verbatim
gdal-config [OPTIONS]
Options:
        [--prefix[=DIR]]
        [--libs]
        [--cflags]
        [--version]
        [--ogr-enabled]
        [--formats]
\endverbatim

\section gdal_config_description DESCRIPTION

This utility script (available on Unix systems) can be used to determine
various information about a GDAL installation.  It is normally just used
by configure scripts for applications using GDAL but can be queried by an
end user.

<dl>
<dt> \-\-prefix:</dt><dd> the top level directory for the GDAL
installation.</dd>
<dt> \-\-libs:</dt><dd> The libraries and link directives required to
use GDAL.</dd>
<dt> \-\-cflags:</dt><dd> The include and macro definition required to compiled
modules using GDAL.</dd>
<dt> \-\-version:</dt><dd> Reports the GDAL version.</dd>
<dt> \-\-ogr-enabled:</dt><dd> Reports "yes" or "no" to standard output depending
on whether OGR is built into GDAL.</dd>
<dt> \-\-formats:</dt><dd> Reports which formats are configured into GDAL
to stdout.
</dd>
</dl>

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

Retiles a set of tiles and/or build tiled pyramid levels.

\if man
\section retile_synopsis SYNOPSIS
\endif

\htmlonly
Usage:
\endhtmlonly

\verbatim

gdal_retile.py [-v] [-co NAME=VALUE]* [-of out_format] [-ps pixelWidth pixelHeight]
               [-overlap val_in_pixel]
               [-ot  {Byte/Int16/UInt16/UInt32/Int32/Float32/Float64/
                      CInt16/CInt32/CFloat32/CFloat64}]'
               [ -tileIndex tileIndexName [-tileIndexField tileIndexFieldName]]
               [ -csv fileName [-csvDelim delimiter]]
               [-s_srs srs_def]  [-pyramidOnly]
               [-r {near/bilinear/cubic/cubicspline/lanczos}]
               -levels numberoflevels
               [-useDirForEachRow]
               -targetDir TileDirectory input_files

\endverbatim
\if man
\section retile_description DESCRIPTION
\endif

This utility will retile a set of input tile(s). All the input tile(s) must
be georeferenced in the same coordinate system and have a matching number of bands.
Optionally pyramid levels are generated. It  is  possible to generate  shape file(s) for the tiled output.

If your number of input tiles exhausts the command line buffer, use the general --optfile option

<dl>
<dt> -targetDir directory:</dt><dd>
The directory where the tile result is created. Pyramids are stored
in sub-directories numbered from 1. Created tile names have a numbering
schema and contain the name of the source tiles(s)
</dd>
<dt> -of format:</dt><dd>
Output format, defaults to GeoTIFF (GTiff).
</dd>
<dt> -co NAME=VALUE:</dt><dd>
Creation option for output file. Multiple options can be specified.
See <a class="el"
href="formats_list.html" title="GDAL Raster Formats">format specific
documentation for legal creation options for each format</a>
</dd>
<dt> -ot datatype:</dt><dd>
Force the output image bands to have a specific type. Use type names (i.e. Byte, Int16,...)
</dd>
<dt> -ps pixelsize_x pixelsize_y:</dt><dd> Pixel size to be used for the
output file. If not specified, 256 x 256 is the default
</dd>
<dt> -overlap val_in_pixel:</dt><dd> (GDAL &gt;= 2.2) Overlap in
pixels between consecutive tiles. If not specified, 0 is the default
</dd>
<dt> -levels numberOfLevels:</dt><dd>
Number of pyramids levels to build.
</dd>
<dt> -v:</dt><dd>
Generate verbose output of tile operations as they are done.
</dd>
<dt> -pyramidOnly:</dt><dd>
No retiling, build only the pyramids
</dd>
<dt> -r algorithm:</dt><dd>
Resampling algorithm, default is near
</dd>
<dt> -s_srs srs_def:</dt><dd>
Source spatial reference to use. The coordinate systems that can be
passed are anything supported by the OGRSpatialReference.SetFromUserInput() call,
which includes EPSG, PCS, and GCSes (i.e. EPSG:4296), PROJ.4 declarations (as above),
or the name of a .prj file containing well known text.
If no srs_def is given, the srs_def of the source tiles is used (if there is any).
The srs_def will be propagated to created tiles (if possible) and to the optional
shape file(s)
</dd>
<dt> -tileIndex tileIndexName:</dt><dd>
The name of shape file containing the result tile(s) index
</dd>
<dt> -tileIndexField tileIndexFieldName:</dt><dd>
The name of the attribute containing the tile name
</dd>
<dt> -csv csvFileName:</dt><dd>
The name of the csv file containing the tile(s) georeferencing information.
The file contains 5 columns: tilename,minx,maxx,miny,maxy
</dd>
<dt> -csvDelim column delimiter:</dt><dd>
The column delimiter used in the CSV file, default value is a semicolon ";"
</dd>
<dt> -useDirForEachRow:</dt><dd>
Normally the tiles of the base image are stored as described in -targetDir.
For large images, some file systems have performance problems if the number of files
in a directory is to big, causing gdal_retile not to finish in reasonable time.
Using this parameter creates a different output structure. The tiles of the base image
are stored in a sub-directory called 0, the pyramids in sub-directories numbered 1,2,....
Within each of these directories another level of sub-directories is created, numbered from
0...n, depending of how many tile rows are needed for each level. Finally, a directory contains
only the tiles for one row for a specific level. For large images a performance improvement
of a factor N could be achieved.
</dd>
</dl>

NOTE: gdal_retile.py is a Python script, and will only work if GDAL was built
with Python support.

\if man
\section retile_author AUTHORS
Christian Mueller <christian.mueller@nvoe.at>
\endif
*/

*******************************************************************************
/*!
\if man
\page gdal_grid
\else
\page gdal_grid gdal_grid
\endif

Creates regular grid from the scattered data.

\section gdal_grid_synopsis SYNOPSIS

\verbatim
gdal_grid [-ot {Byte/Int16/UInt16/UInt32/Int32/Float32/Float64/
 CInt16/CInt32/CFloat32/CFloat64}]
 [-of format] [-co "NAME=VALUE"]
 [-zfield field_name] [-z_increase increase_value] [-z_multiply multiply_value]
 [-a_srs srs_def] [-spat xmin ymin xmax ymax]
 [-clipsrc <xmin ymin xmax ymax>|WKT|datasource|spat_extent]
 [-clipsrcsql sql_statement] [-clipsrclayer layer]
 [-clipsrcwhere expression]
 [-l layername]* [-where expression] [-sql select_statement]
 [-txe xmin xmax] [-tye ymin ymax] [-outsize xsize ysize]
 [-a algorithm[:parameter1=value1]*] [-q]
 <src_datasource> <dst_filename>
\endverbatim

\section gdal_grid_description DESCRIPTION

This program creates regular grid (raster) from the scattered data read from
the OGR datasource. Input data will be interpolated to fill grid nodes with
values, you can choose from various interpolation methods.

Starting with GDAL 1.10, it is possible to set the GDAL_NUM_THREADS
configuration option to parallelize the processing. The value to specify is
the number of worker threads, or ALL_CPUS to use all the cores/CPUs of the
computer.

<dl>

<dt> -ot type:</dt><dd> For the output bands to be of the
indicated data type.</dd>

<dt> -of format:</dt><dd> Select the output format. The default
is GeoTIFF (GTiff). Use the short format name.</dd>

<dt> -txe xmin xmax:</dt><dd> Set georeferenced
X extents of output file to be created.</dd>

<dt> -tye ymin ymax:</dt><dd> Set georeferenced
Y extents of output file to be created.</dd>

<dt> -outsize xsize ysize:</dt><dd> Set the size of the
output file in pixels and lines.</dd>

<dt> -a_srs srs_def:</dt><dd> Override the projection for the
output file. The srs_def may be any of the usual GDAL/OGR forms,
complete WKT, PROJ.4, EPSG:n or a file containing the WKT. </dd>

<dt> -zfield field_name:</dt><dd> Identifies an attribute field
on the features to be used to get a Z value from. This value overrides Z value
read from feature geometry record (naturally, if you have a Z value in
geometry, otherwise you have no choice and should specify a field name
containing Z value).</dd>

<dt> -z_increase increase_value:</dt><dd> Addition to the attribute field
on the features to be used to get a Z value from. The addition should be the same
unit as Z value. The result value will be Z value + Z increase value. The default value is 0.</dd>

<dt> -z_multiply multiply_value:</dt><dd> This is multiplication
ratio for Z field. This can be used for shift from e.g. foot to meters or from
elevation to deep. The result value will be (Z value + Z increase value) * Z multiply value.
The default value is 1.</dd>

<dt> -a [algorithm[:parameter1=value1][:parameter2=value2]...]:
</dt><dd> Set the interpolation algorithm or data metric name and (optionally)
its parameters. See \ref gdal_grid_algorithms and \ref gdal_grid_metrics
sections for further discussion of available options.</dd>

<dt> -spat xmin ymin xmax ymax:</dt><dd> Adds a spatial filter
to select only features contained within the bounding box described by
(xmin, ymin) - (xmax, ymax).</dd>

<dt> -clipsrc [xmin ymin xmax ymax]|WKT|datasource|spat_extent:
</dt><dd> Adds a spatial filter to select only features contained within the
specified bounding box (expressed in source SRS), WKT geometry (POLYGON or
MULTIPOLYGON), from a datasource or to the spatial extent of the -spat
option if you use the spat_extent keyword. When specifying a
datasource, you will generally want to use it in combination of the
-clipsrclayer, -clipsrcwhere or -clipsrcsql
options.</dd>

<dt> -clipsrcsql sql_statement:</dt><dd>Select desired
geometries using an SQL query instead.</dd>

<dt> -clipsrclayer layername:</dt><dd>Select the named layer
from the source clip datasource.</dd>

<dt> -clipsrcwhere expression:</dt><dd>Restrict desired
geometries based on attribute query.</dd>

<dt> -l layername: </dt><dd> Indicates the layer(s) from the
datasource that will be used for input features. May be specified multiple
times, but at least one layer name or a -sql option must be
specified.</dd>

<dt> -where expression: </dt><dd>
An optional SQL WHERE style query expression to be applied to select features
to process from the input layer(s). </dd>

<dt> -sql select_statement: </dt><dd>
An SQL statement to be evaluated against the datasource to produce a
virtual layer of features to be processed.</dd>

<dt> -co "NAME=VALUE":</dt><dd> Passes a creation option to the
output format driver. Multiple -co options may be listed. See <a class="el"
href="formats_list.html" title="GDAL Raster Formats">format specific
documentation for legal creation options for each format</a>.</dd>

<dt> -q:</dt><dd> Suppress progress monitor and other non-error
output.</dd>

<dt> src_datasource: </dt><dd>
Any OGR supported readable datasource.</dd>

<dt> dst_filename: </dt><dd>
The GDAL supported output file.</dd>

</dl>

\section gdal_grid_algorithms INTERPOLATION ALGORITHMS

There are number of interpolation algorithms to choose from.

\subsection gdal_grid_algorithms_invdist invdist

Inverse distance to a power. This is default algorithm. It has following
parameters:

<dl>
<dt>power:</dt> <dd>Weighting power (default 2.0).</dd>
<dt>smoothing:</dt> <dd>Smoothing parameter (default 0.0).</dd>
<dt>radius1:</dt> <dd>The first radius (X axis if rotation angle is 0)
of search ellipse. Set this parameter to zero to use whole point array.
Default is 0.0.</dd>
<dt>radius2:</dt> <dd>The second radius (Y axis if rotation angle is 0)
of search ellipse. Set this parameter to zero to use whole point array.
Default is 0.0.</dd>
<dt>angle:</dt> <dd>Angle of search ellipse rotation in degrees
(counter clockwise, default 0.0).</dd>
<dt>max_points:</dt> <dd>Maximum number of data points to use. Do not
search for more points than this number. This is only used if search ellipse
is set (both radii are non-zero). Zero means that all found points should
be used. Default is 0.</dd>
<dt>min_points:</dt> <dd>Minimum number of data points to use. If less
amount of points found the grid node considered empty and will be filled with
NODATA marker. This is only used if search ellipse is set (both radii are
non-zero). Default is 0.</dd>
<dt>nodata:</dt> <dd>NODATA marker to fill empty points (default
0.0).</dd>
</dl>

\subsection gdal_grid_algorithms_invdist_nearest_neighbor invdistnn

(Since GDAL 2.1) Inverse distance to a power with nearest neighbor searching, ideal when
max_points is used. It has following parameters:

<dl>
<dt>power:</dt> <dd>Weighting power (default 2.0).</dd>
<dt>smoothing:</dt> <dd>Smoothing parameter (default 0.0).</dd>
<dt>radius:</dt> <dd>The radius of the search circle, which should be
non-zero. Default is 1.0.</dd>
<dt>max_points:</dt> <dd>Maximum number of data points to use. Do not
search for more points than this number. Found points will be ranked from
nearest to furthest distance when weighting. Default is 12.</dd>
<dt>min_points:</dt> <dd>Minimum number of data points to use. If less
amount of points found the grid node is considered empty and will be filled
with NODATA marker. Default is 0.</dd>
<dt>nodata:</dt> <dd>NODATA marker to fill empty points (default
0.0).</dd>
</dl>

\subsection gdal_grid_algorithms_average average

Moving average algorithm. It has following parameters:

<dl>
<dt>radius1:</dt> <dd>The first radius (X axis if rotation angle is 0)
of search ellipse. Set this parameter to zero to use whole point array.
Default is 0.0.</dd>
<dt>radius2:</dt> <dd>The second radius (Y axis if rotation angle is 0)
of search ellipse. Set this parameter to zero to use whole point array.
Default is 0.0.</dd>
<dt>angle:</dt> <dd>Angle of search ellipse rotation in degrees
(counter clockwise, default 0.0).</dd>
<dt>min_points:</dt> <dd>Minimum number of data points to use. If less
amount of points found the grid node considered empty and will be filled with
NODATA marker. Default is 0.</dd>
<dt>nodata:</dt> <dd>NODATA marker to fill empty points (default
0.0).</dd>
</dl>

Note, that it is essential to set search ellipse for moving average method. It
is a window that will be averaged when computing grid nodes values.

\subsection gdal_grid_algorithms_nearest nearest

Nearest neighbor algorithm. It has following parameters:

<dl>
<dt>radius1:</dt> <dd>The first radius (X axis if rotation angle is 0)
of search ellipse. Set this parameter to zero to use whole point array.
Default is 0.0.</dd>
<dt>radius2:</dt> <dd>The second radius (Y axis if rotation angle is 0)
of search ellipse. Set this parameter to zero to use whole point array.
Default is 0.0.</dd>
<dt>angle:</dt> <dd>Angle of search ellipse rotation in degrees
(counter clockwise, default 0.0).</dd>
<dt>nodata:</dt> <dd>NODATA marker to fill empty points (default
0.0).</dd>
</dl>

\subsection gdal_grid_algorithms_linear linear

(Since GDAL 2.1) Linear interpolation algorithm.

The Linear method performs linear interpolation by computing a Delaunay
triangulation of the point cloud, finding in which triangle of the triangulation
the point is, and by doing linear interpolation from its barycentric coordinates
within the triangle.
If the point is not in any triangle, depending on the radius, the
algorithm will use the value of the nearest point or the nodata value.

It has following parameters:

<dl>
<dt>radius:</dt> <dd>In case the point to be interpolated does not fit
into a triangle of the Delaunay triangulation, use that maximum distance to search a nearest
neighbour, or use nodata otherwise. If set to -1, the search distance is infinite.
If set to 0, nodata value will be always used. Default is -1.</dd>
<dt>nodata:</dt> <dd>NODATA marker to fill empty points (default
0.0).</dd>
</dl>

\section gdal_grid_metrics DATA METRICS

Besides the interpolation functionality \ref gdal_grid can be used to compute
some data metrics using the specified window and output grid geometry. These
metrics are:

<dl>

<dt>minimum:</dt> <dd>Minimum value found in grid node search
ellipse.</dd>

<dt>maximum:</dt> <dd>Maximum value found in grid node search
ellipse.</dd>

<dt>range:</dt> <dd>A difference between the minimum and maximum values
found in grid node search ellipse.</dd>

<dt>count:</dt> <dd> A number of data points found in grid node search
ellipse.</dd>

<dt>average_distance:</dt> <dd>An average distance between the grid
node (center of the search ellipse) and all of the data points found in grid
node search ellipse.</dd>

<dt>average_distance_pts:</dt> <dd>An average distance between the data
points found in grid node search ellipse. The distance between each pair of
points within ellipse is calculated and average of all distances is set as a
grid node value.</dd>

</dl>

All the metrics have the same set of options:

<dl>

<dt>radius1:</dt> <dd>The first radius (X axis if rotation angle is 0)
of search ellipse. Set this parameter to zero to use whole point array.
Default is 0.0.</dd>
<dt>radius2:</dt> <dd>The second radius (Y axis if rotation angle is 0)
of search ellipse. Set this parameter to zero to use whole point array.
Default is 0.0.</dd>
<dt>angle:</dt> <dd>Angle of search ellipse rotation in degrees
(counter clockwise, default 0.0).</dd>
<dt>min_points:</dt> <dd>Minimum number of data points to use. If less
amount of points found the grid node considered empty and will be filled with
NODATA marker. This is only used if search ellipse is set (both radii are
non-zero). Default is 0.</dd>
<dt>nodata:</dt> <dd>NODATA marker to fill empty points (default
0.0).</dd>

</dl>

\section gdal_grid_csv READING COMMA SEPARATED VALUES

Often you have a text file with a list of comma separated XYZ values to work
with (so called CSV file). You can easily use that kind of data source in \ref
gdal_grid. All you need is create a virtual dataset header (VRT) for you CSV
file and use it as input datasource for \ref gdal_grid. You can find details
on VRT format at <a href="ogr/drv_vrt.html">Virtual Format</a> description
page.

Here is a small example. Let we have a CSV file called dem.csv
containing

\verbatim
Easting,Northing,Elevation
86943.4,891957,139.13
87124.3,892075,135.01
86962.4,892321,182.04
87077.6,891995,135.01
...
\endverbatim

For above data we will create dem.vrt header with the following
content:

\verbatim
<OGRVRTDataSource>
 <OGRVRTLayer name="dem">
 <SrcDataSource>dem.csv</SrcDataSource>
 <GeometryType>wkbPoint</GeometryType>
 <GeometryField encoding="PointFromColumns" x="Easting" y="Northing" z="Elevation"/>
 </OGRVRTLayer>
</OGRVRTDataSource>
\endverbatim

This description specifies so called 2.5D geometry with three coordinates X, Y
and Z. Z value will be used for interpolation. Now you can use dem.vrt
with all OGR programs (start with \ref ogrinfo to test that everything works
fine). The datasource will contain single layer called "dem" filled
with point features constructed from values in CSV file. Using this technique
you can handle CSV files with more than three columns, switch columns, etc.

If your CSV file does not contain column headers then it can be handled in the
following way:

\verbatim
<GeometryField encoding="PointFromColumns" x="field_1" y="field_2" z="field_3"/>
\endverbatim

<a href="ogr/drv_csv.html">Comma Separated Value</a> description page contains
details on CSV format supported by GDAL/OGR.

\section gdal_grid_api C API

Starting with GDAL 2.1, this utility is also callable from C with GDALGrid().

\section gdal_grid_example EXAMPLE

The following would create raster TIFF file from VRT datasource described in
\ref gdal_grid_csv section using the inverse distance to a power method.
Values to interpolate will be read from Z value of geometry record.

\verbatim
gdal_grid -a invdist:power=2.0:smoothing=1.0 -txe 85000 89000 -tye 894000 890000 -outsize 400 400 -of GTiff -ot Float64 -l dem dem.vrt dem.tiff
\endverbatim

The next command does the same thing as the previous one, but reads values to
interpolate from the attribute field specified with -zfield option
instead of geometry record. So in this case X and Y coordinates are being
taken from geometry and Z is being taken from the "Elevation" field.
The GDAL_NUM_THREADS is also set to parallelize the computation.

\verbatim
gdal_grid -zfield "Elevation" -a invdist:power=2.0:smoothing=1.0 -txe 85000 89000 -tye 894000 890000 -outsize 400 400 -of GTiff -ot Float64 -l dem dem.vrt dem.tiff --config GDAL_NUM_THREADS ALL_CPUS
\endverbatim

\if man
\section gdal_grid_author AUTHORS
Andrey Kiselev <dron@ak4719.spb.edu>
\endif
*/

*******************************************************************************
/*!
\if man
\page gdaldem
\else
\page gdaldem gdaldem
\endif

Tools to analyze and visualize DEMs.

\section gdaldem_synopsis SYNOPSIS

\htmlonly
Usage:
\endhtmlonly

\verbatim

- To generate a shaded relief map from any GDAL-supported elevation raster :
    gdaldem hillshade input_dem output_hillshade
                [-z ZFactor (default=1)] [-s scale* (default=1)]"
                [-az Azimuth (default=315)] [-alt Altitude (default=45)]
                [-alg ZevenbergenThorne] [-combined | -multidirectional]
                [-compute_edges] [-b Band (default=1)] [-of format] [-co "NAME=VALUE"]* [-q]

- To generate a slope map from any GDAL-supported elevation raster :
    gdaldem slope input_dem output_slope_map"
                [-p use percent slope (default=degrees)] [-s scale* (default=1)]
                [-alg ZevenbergenThorne]
                [-compute_edges] [-b Band (default=1)] [-of format] [-co "NAME=VALUE"]* [-q]

- To generate an aspect map from any GDAL-supported elevation raster
  Outputs a 32-bit float raster with pixel values from 0-360 indicating azimuth :
    gdaldem aspect input_dem output_aspect_map"
                [-trigonometric] [-zero_for_flat]
                [-alg ZevenbergenThorne]
                [-compute_edges] [-b Band (default=1)] [-of format] [-co "NAME=VALUE"]* [-q]

- To generate a color relief map from any GDAL-supported elevation raster
    gdaldem color-relief input_dem color_text_file output_color_relief_map
                [-alpha] [-exact_color_entry | -nearest_color_entry]
                [-b Band (default=1)] [-of format] [-co "NAME=VALUE"]* [-q]
    where color_text_file contains lines of the format "elevation_value red green blue"

- To generate a Terrain Ruggedness Index (TRI) map from any GDAL-supported elevation raster:
    gdaldem TRI input_dem output_TRI_map
                [-compute_edges] [-b Band (default=1)] [-of format] [-q]

- To generate a Topographic Position Index (TPI) map from any GDAL-supported elevation raster:
    gdaldem TPI input_dem output_TPI_map
                [-compute_edges] [-b Band (default=1)] [-of format] [-q]

- To generate a roughness map from any GDAL-supported elevation raster:
    gdaldem roughness input_dem output_roughness_map
                [-compute_edges] [-b Band (default=1)] [-of format] [-q]

Notes :
  gdaldem generally assumes that x, y and z units are identical.  If x (east-west)
  and y (north-south) units are identical, but z (elevation) units are different, the
  scale (-s) option can be used to set the ratio of vertical units to horizontal.  For
  LatLong projections near the equator, where units of latitude and units of
  longitude are similar, elevation (z) units can be converted to be compatible
  by using scale=370400 (if elevation is in feet) or scale=111120 (if elevation is in
  meters).  For locations not near the equator, it would be best to reproject your
  grid using gdalwarp before using gdaldem.

\endverbatim
\if man
\section gdaldem_description DESCRIPTION
\endif

This utility has 7 different modes :
<dl>
<dt>\ref gdaldem_hillshade</dt><dd>to generate a shaded relief map from any GDAL-supported elevation raster</dd>
<dt>\ref gdaldem_slope</dt><dd>to generate a slope map from any GDAL-supported elevation raster</dd>
<dt>\ref gdaldem_aspect</dt><dd>to generate an aspect map from any GDAL-supported elevation raster</dd>
<dt>\ref gdaldem_color_relief</dt><dd>to generate a color relief map from any GDAL-supported elevation raster</dd>
<dt>\ref gdaldem_TRI</dt><dd>to generate a map of Terrain Ruggedness Index from any GDAL-supported elevation raster</dd>
<dt>\ref gdaldem_TPI</dt><dd>to generate a map of Topographic Position Index from any GDAL-supported elevation raster</dd>
<dt>\ref gdaldem_roughness</dt><dd>to generate a map of roughness from any GDAL-supported elevation raster</dd>
</dl>

The following general options are available :
<dl>
<dt> input_dem:</dt><dd> The input DEM raster to be processed</dd>
<dt> output_xxx_map:</dt><dd> The output raster produced</dd>
<dt> -of format:</dt><dd> Select the output format. The default
is GeoTIFF (GTiff). Use the short format name.</dd>
<dt> -compute_edges:</dt><dd> (GDAL >= 1.8.0) Do the computation at raster edges and near nodata values</dd>
<dt> -alg ZevenbergenThorne:</dt><dd> (GDAL >= 1.8.0) Use Zevenbergen & Thorne formula, instead of Horn's formula, to compute slope & aspect. The literature suggests Zevenbergen & Thorne to be more suited to smooth landscapes, whereas Horn's formula to perform better on rougher terrain.</dd>
<dt> -b band:</dt><dd> Select an input band to be processed. Bands are numbered from 1.</dd>
<dt> -co "NAME=VALUE":</dt><dd> Passes a creation option to the
output format driver. Multiple -co options may be listed. See <a class="el"
href="formats_list.html" title="GDAL Raster Formats">format specific
documentation for legal creation options for each format</a></dd>
<dt> -q:</dt><dd> Suppress progress monitor and other non-error
output.</dd>
</dl>

For all algorithms, except color-relief, a nodata value in the target dataset will be emitted if
at least one pixel set to the nodata value is found in the 3x3 window centered around each source pixel.
The consequence is that there will be a 1-pixel border around each image set with nodata value.
From GDAL 1.8.0, if -compute_edges is specified, gdaldem will compute values at image edges
or if a nodata value is found in the 3x3 window, by interpolating missing values.

\section gdaldem_modes Modes

\subsection gdaldem_hillshade hillshade

This command outputs an 8-bit raster with a nice shaded relief effect.
It’s very useful for visualizing the terrain.
You can optionally specify the azimuth and altitude of the light source,
a vertical exaggeration factor and a scaling factor to account for differences between vertical and horizontal units.

The value 0 is used as the output nodata value.

The following specific options are available :
<dl>
<dt> -z zFactor:</dt><dd>vertical exaggeration used to pre-multiply the elevations</dd>
<dt> -s scale:</dt><dd>ratio of vertical units to horizontal. If the horizontal unit of the source DEM is degrees (e.g Lat/Long WGS84 projection), you can use scale=111120 if the vertical units are meters (or scale=370400 if they are in feet)</dd>
<dt> -az azimuth:</dt><dd>azimuth of the light, in degrees. 0 if it comes from the top of the raster, 90 from the east, ... The default value, 315, should rarely be changed as it is the value generally used to generate shaded maps.</dd>
<dt> -alt altitude:</dt><dd>altitude of the light, in degrees. 90 if the light comes from above the DEM, 0 if it is raking light.</dd>
<dt> -combined:</dt><dd>(starting with GDAL 1.10) combined shading, a combination of slope and oblique shading.</dd>
<dt> -multidirectional:</dt><dd>(starting with GDAL 2.2) multidirectional shading, a combination of hillshading illuminated from 225 deg, 270 deg, 315 deg, and 360 deg azimuth.</dd>
</dl>

Multidirectional hillshading applies the formula of http://pubs.usgs.gov/of/1992/of92-422/of92-422.pdf.

\subsection gdaldem_slope slope

This command will take a DEM raster and output a 32-bit float raster with slope values.
You have the option of specifying the type of slope value you want: degrees or percent slope.
In cases where the horizontal units differ from the vertical units, you can also supply a scaling factor.

The value -9999 is used as the output nodata value.

The following specific options are available :
<dl>
<dt> -p :</dt><dd>if specified, the slope will be expressed as percent slope. Otherwise, it is expressed as degrees</dd>
<dt> -s scale:</dt><dd>ratio of vertical units to horizontal. If the horizontal unit of the source DEM is degrees (e.g Lat/Long WGS84 projection), you can use scale=111120 if the vertical units are meters (or scale=370400 if they are in feet)</dd>
</dl>

\subsection gdaldem_aspect aspect

This command outputs a 32-bit float raster with values between 0° and 360° representing the azimuth that slopes are facing.
The definition of the azimuth is such that : 0° means that the slope is facing the North, 90° it's facing the East, 180° it's facing the South and
270° it's facing the West (provided that the top of your input raster is north oriented). The aspect value -9999 is used as the nodata value
to indicate undefined aspect in flat areas with slope=0.

The following specifics options are available :
<dl>
<dt> -trigonometric:</dt><dd> return trigonometric angle instead of azimuth. Thus 0° means East, 90° North, 180° West, 270° South</dd>
<dt> -zero_for_flat:</dt><dd> return 0 for flat areas with slope=0, instead of -9999</dd>
</dl>

By using those 2 options, the aspect returned by gdaldem aspect should be identical to the one of GRASS r.slope.aspect. Otherwise, it's identical
to the one of Matthew Perry's aspect.cpp utility.

\subsection gdaldem_color_relief color-relief

This command outputs a 3-band (RGB) or 4-band (RGBA) raster with values are computed from the elevation
and a text-based color configuration file, containing the association between various elevation
values and the corresponding wished color. By default, the colors between the given elevation values
are blended smoothly and the result is a nice colorized DEM. The -exact_color_entry or
-nearest_color_entry options can be used to avoid that linear interpolation for values that don't match an index
of the color configuration file.

The following specifics options are available :
<dl>
<dt> color_text_file:</dt><dd> text-based color configuration file</dd>
<dt> -alpha :</dt><dd>add an alpha channel to the output raster</dd>
<dt> -exact_color_entry :</dt><dd>use strict matching when searching in the color configuration file.
 If none matching color entry is found, the "0,0,0,0" RGBA quadruplet will be used</dd>
<dt> -nearest_color_entry :</dt><dd></dd>use the RGBA quadruplet corresponding to the closest entry in the color configuration file.</dd>
</dl>

The color-relief mode is the only mode that supports VRT as output format. In that case, it will translate the color configuration file into appropriate LUT elements. Note that elevations specified as percentage will be translated as absolute values, which must be taken into account when the statistics of the source raster differ from the one that was used when building the VRT.

The text-based color configuration file generally contains 4 columns per line : the elevation value and the
corresponding Red, Green, Blue component (between 0 and 255).
The elevation value can be any floating point value, or the nv keyword for the nodata value..
The elevation can also be expressed as a percentage : 0% being the minimum value found in the raster, 100% the maximum value.

An extra column can be optionally added for the alpha component. If it is not specified, full opacity (255) is assumed.

Various field separators are accepted : comma, tabulation, spaces, ':'.

Common colors used by GRASS can also be specified by using their name, instead of the RGB triplet. The supported list is :
white, black, red, green, blue, yellow, magenta, cyan, aqua, grey/gray, orange, brown, purple/violet and indigo.

Since GDAL 1.8.0, GMT .cpt palette files are also supported (COLOR_MODEL = RGB only).

Note: the syntax of the color configuration file is derived from the one supported by GRASS r.colors utility.
ESRI HDR color table files (.clr) also match that syntax.
The alpha component and the support of tab and comma as separators are GDAL specific extensions.

For example :
\verbatim
3500   white
2500   235:220:175
50%   190 185 135
700    240 250 150
0      50  180  50
nv     0   0   0   0
\endverbatim

\subsection gdaldem_TRI TRI

This command outputs a single-band raster with values computed from the elevation.
TRI stands for Terrain Ruggedness Index, which is defined as the mean difference between a central pixel and its surrounding cells (see Wilson et al 2007, Marine Geodesy 30:3-35).

The value -9999 is used as the output nodata value.

There are no specific options.

\subsection gdaldem_TPI TPI

This command outputs a single-band raster with values computed from the elevation.
TPI stands for Topographic Position Index, which is defined as the difference between a central pixel and the mean of its surrounding cells (see Wilson et al 2007, Marine Geodesy 30:3-35).

The value -9999 is used as the output nodata value.

There are no specific options.

\subsection gdaldem_roughness roughness

This command outputs a single-band raster with values computed from the elevation.
Roughness is the largest inter-cell difference of a central pixel and its surrounding cell, as defined in Wilson et al (2007, Marine Geodesy 30:3-35).

The value -9999 is used as the output nodata value.

There are no specific options.

\section gdaldem_api C API

Starting with GDAL 2.1, this utility is also callable from C with GDALDEMProcessing().

\section gdaldem_author AUTHORS
Matthew Perry <perrygeo@gmail.com>, Even Rouault <even.rouault@mines-paris.org>, Howard Butler <hobu.inc@gmail.com>, Chris Yesson <chris.yesson@ioz.ac.uk>

Derived from code by Michael Shapiro, Olga Waupotitsch, Marjorie Larson, Jim Westervelt :
U.S. Army CERL, 1993. GRASS 4.1 Reference Manual. U.S. Army Corps of Engineers,
Construction Engineering Research Laboratories, Champaign, Illinois, 1-425.

\section gdaldem_seealso See also

Documentation of related GRASS utilities :

http://grass.osgeo.org/grass64/manuals/html64_user/r.slope.aspect.html

http://grass.osgeo.org/grass64/manuals/html64_user/r.shaded.relief.html

http://grass.osgeo.org/grass64/manuals/html64_user/r.colors.html

*******************************************************************************
/*!
\if man
\page gdalsrsinfo
\else
\page gdalsrsinfo gdalsrsinfo
\endif

Lists info about a given SRS in number of formats (WKT, PROJ.4, etc.)

\section gdalsrsinfo_synopsis SYNOPSIS

\verbatim
Usage: gdalsrsinfo [options] srs_def

srs_def may be the filename of a dataset supported by GDAL/OGR from which to extract SRS information
OR any of the usual GDAL/OGR forms (complete WKT, PROJ.4, EPSG:n or a file containing the SRS)

Options:
   [--help-general] [-h]  Show help and exit
   [-p]                   Pretty-print where applicable (e.g. WKT)
   [-V]                   Validate SRS
   [-o out_type]          Output type { default, all, wkt_all, proj4,
                                        wkt, wkt_simple, wkt_noct, wkt_esri,
                                        mapinfo, xml }

\endverbatim

\section gdalsrsinfo_description DESCRIPTION

The gdalsrsinfo utility reports information about a given SRS from one of the following:

- The filename of a dataset supported by GDAL/OGR which contains SRS information
- Any of the usual GDAL/OGR forms (complete WKT, PROJ.4, EPSG:n or a file containing the SRS)

Output types:

- default&nbsp;&nbsp;&nbsp;proj4 and wkt (default option)
- all&nbsp;&nbsp;&nbsp;all options available
- wkt_all&nbsp;&nbsp;&nbsp;all wkt options available
- proj4&nbsp;&nbsp;&nbsp;PROJ.4 string
- wkt&nbsp;&nbsp;&nbsp;OGC WKT format (full)
- wkt_simple&nbsp;&nbsp;&nbsp;OGC WKT (simplified)
- wkt_noct&nbsp;&nbsp;&nbsp;OGC WKT (without OGC CT params)
- wkt_esri&nbsp;&nbsp;&nbsp;ESRI WKT format
- mapinfo&nbsp;&nbsp;&nbsp;Mapinfo style CoordSys format
- xml&nbsp;&nbsp;&nbsp;XML format (GML based)

\n
\section gdalsrsinfo_example EXAMPLE

\verbatim
$  gdalsrsinfo   "EPSG:4326"

PROJ.4 : '+proj=longlat +datum=WGS84 +no_defs '

OGC WKT :
GEOGCS["WGS 84",
    DATUM["WGS_1984",
        SPHEROID["WGS 84",6378137,298.257223563,
            AUTHORITY["EPSG","7030"]],
        AUTHORITY["EPSG","6326"]],
    PRIMEM["Greenwich",0,
        AUTHORITY["EPSG","8901"]],
    UNIT["degree",0.0174532925199433,
        AUTHORITY["EPSG","9122"]],
    AUTHORITY["EPSG","4326"]]

\endverbatim

\n
\verbatim
$ gdalsrsinfo -o proj4 osr/data/lcc_esri.prj
'+proj=lcc +lat_1=34.33333333333334 +lat_2=36.16666666666666 +lat_0=33.75 +lon_0=-79 +x_0=609601.22 +y_0=0 +datum=NAD83 +units=m +no_defs '
\endverbatim

\n
\verbatim
$ gdalsrsinfo -o proj4 landsat.tif
PROJ.4 : '+proj=utm +zone=19 +south +datum=WGS84 +units=m +no_defs '
\endverbatim

\n
\verbatim
$ gdalsrsinfo  -o wkt -p  "EPSG:32722"

PROJCS["WGS 84 / UTM zone 22S",
    GEOGCS["WGS 84",
        DATUM["WGS_1984",
            SPHEROID["WGS 84",6378137,298.257223563,
                AUTHORITY["EPSG","7030"]],
            AUTHORITY["EPSG","6326"]],
        PRIMEM["Greenwich",0,
            AUTHORITY["EPSG","8901"]],
        UNIT["degree",0.0174532925199433,
            AUTHORITY["EPSG","9122"]],
        AUTHORITY["EPSG","4326"]],
    PROJECTION["Transverse_Mercator"],
    PARAMETER["latitude_of_origin",0],
    PARAMETER["central_meridian",-51],
    PARAMETER["scale_factor",0.9996],
    PARAMETER["false_easting",500000],
    PARAMETER["false_northing",10000000],
    UNIT["metre",1,
        AUTHORITY["EPSG","9001"]],
    AXIS["Easting",EAST],
    AXIS["Northing",NORTH],
    AUTHORITY["EPSG","32722"]]
\endverbatim

\n
\verbatim
$ gdalsrsinfo  -o wkt_all  "EPSG:4618"

OGC WKT :
GEOGCS["SAD69",
    DATUM["South_American_Datum_1969",
        SPHEROID["GRS 1967 Modified",6378160,298.25,
            AUTHORITY["EPSG","7050"]],
        TOWGS84[-57,1,-41,0,0,0,0],
        AUTHORITY["EPSG","6618"]],
    PRIMEM["Greenwich",0,
        AUTHORITY["EPSG","8901"]],
    UNIT["degree",0.0174532925199433,
        AUTHORITY["EPSG","9122"]],
    AUTHORITY["EPSG","4618"]]

OGC WKT (simple) :
GEOGCS["SAD69",
    DATUM["South_American_Datum_1969",
        SPHEROID["GRS 1967 Modified",6378160,298.25],
        TOWGS84[-57,1,-41,0,0,0,0]],
    PRIMEM["Greenwich",0],
    UNIT["degree",0.0174532925199433]]

OGC WKT (no CT) :
GEOGCS["SAD69",
    DATUM["South_American_Datum_1969",
        SPHEROID["GRS 1967 Modified",6378160,298.25]],
    PRIMEM["Greenwich",0],
    UNIT["degree",0.0174532925199433]]

ESRI WKT :
GEOGCS["SAD69",
    DATUM["D_South_American_1969",
        SPHEROID["GRS_1967_Truncated",6378160,298.25]],
    PRIMEM["Greenwich",0],
    UNIT["Degree",0.017453292519943295]]
\endverbatim

\if man
\section gdalsrsinfo_author AUTHORS
Frank Warmerdam <warmerdam@pobox.com>, Etienne Tourigny <etourigny.dev-at-gmail-dot-com>
\endif
*/

*******************************************************************************
/*!
\if man
\page gdalmanage
\else
\page gdalmanage gdalmanage
\endif

Identify, delete, rename and copy raster data files.

\section gdalmanage_synopsis SYNOPSIS

\verbatim
Usage: gdalmanage mode [-r] [-u] [-f format]
                  datasetname [newdatasetname]
\endverbatim

\section gdalmanage_description DESCRIPTION

The gdalmanage program can perform various operations on raster data files, depending on the chosen mode. This includes identifying raster data types and deleting, renaming or copying the files.

<dl>
<dt> mode:</dt><dd>Mode of operation</dd>
 <dl>
 <dt> identify datasetname:</dt><dd>List data format of file.</dd>
 <dt> copy datasetname newdatasetname:</dt><dd>Create a copy of the raster file with a new name.</dd>
 <dt> rename datasetname newdatasetname:</dt><dd>Change the name of the raster file.</dd>
 <dt> delete datasetname:</dt><dd>Delete raster file.</dd>
 </dl>

<dt> -r:</dt><dd>Recursively scan files/folders for raster files.</dd>
 <dt> -u:</dt><dd>Report failures if file type is unidentified.</dd>
 <dt> -f format:</dt><dd>Specify format of raster file if unknown by the application. Uses short data format name (e.g. GTiff).</dd>

<dt> datasetname:</dt><dd>Raster file to operate on.</dd>
<dt> newdatasetname:</dt><dd>For copy and rename modes, you provide a source filename and a target filename, just like copy and move commands in an operating system.</dd>
</dl>

\section gdalmanage_examples EXAMPLES

\subsection gdalmanage_example_identify Using identify mode

Report the data format of the raster file by using the identify mode and specifying a data file name:

\verbatim
$ gdalmanage identify NE1_50M_SR_W.tif

NE1_50M_SR_W.tif: GTiff
\endverbatim

Recursive mode will scan subfolders and report the data format:

\verbatim
$ gdalmanage identify -r 50m_raster/

NE1_50M_SR_W/ne1_50m.jpg: JPEG
NE1_50M_SR_W/ne1_50m.png: PNG
NE1_50M_SR_W/ne1_50m_20pct.tif: GTiff
NE1_50M_SR_W/ne1_50m_band1.tif: GTiff
NE1_50M_SR_W/ne1_50m_print.png: PNG
NE1_50M_SR_W/NE1_50M_SR_W.aux: HFA
NE1_50M_SR_W/NE1_50M_SR_W.tif: GTiff
NE1_50M_SR_W/ne1_50m_sub.tif: GTiff
NE1_50M_SR_W/ne1_50m_sub2.tif: GTiff

\endverbatim
\subsection gdalmanage_example_copy Using copy mode

Copy the raster data:

\verbatim
$ gdalmanage copy NE1_50M_SR_W.tif ne1_copy.tif
\endverbatim

\subsection gdalmanage_example_rename Using rename mode

Rename raster data:
\verbatim
$ gdalmanage rename NE1_50M_SR_W.tif ne1_rename.tif
\endverbatim

\subsection gdalmanage_example_delete Using delete mode

Delete the raster data:

\verbatim
gdalmanage delete NE1_50M_SR_W.tif
\endverbatim

\if man
\section gdalmanage_author AUTHORS
Tyler Mitchell <spatialguru@shaw.ca>
\endif
*/

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

Perform a pansharpen operation.

(Since GDAL 2.1)

\section gdal_pansharpen_synopsis SYNOPSIS

\verbatim
gdal_pansharpen [--help-general] pan_dataset {spectral_dataset[,band=num]}+ out_dataset
                [-of format] [-b band]* [-w weight_val]*
                [-r {nearest,bilinear,cubic,cubicspline,lanczos,average}]
                [-threads {ALL_CPUS|number}] [-bitdepth val] [-nodata val]
                [-spat_adjust {union,intersection,none,nonewithoutwarning}]
                [-co NAME=VALUE]* [-q]
\endverbatim

\section gdal_pansharpen_description DESCRIPTION

The gdal_pansharpen.py script performs a pan-sharpening operation. It can create
a "classic" output dataset (such as GeoTIFF), or a VRT dataset describing the
pan-sharpening operation.

More details can be found in the <a href="gdal_vrttut.html#gdal_vrttut_pansharpen">VRT tutorial</a>.

<dl>
<dt> -of format:</dt><dd> Select the output format. The default
is GeoTIFF (GTiff). "VRT" can also be used. Use the short format name.</dd>
<dt> -b band:</dt><dd> Select band band from the input spectral
bands for output. Bands are numbered from 1 in the order spectral bands are specified.
Multiple -b switches may be used.
When no -b switch is used, all input spectral bands are set for output.</dd>
<dt> -w weight_val:</dt><dd>Specify a weight for the computation of the
pseudo panchromatic value. There must be as many -w switches as input spectral bands.</dd>
<dt> -r
{nearest,bilinear,cubic (default),cubicspline,lanczos,average}:</dt><dd>
Select a resampling algorithm.</dd>
<dt> -threads {ALL_CPUS,number}:</dt><dd>
Specify number of threads to use to do the resampling and pan-sharpening itself.
Can be an integer number or ALL_CPUS.</dd>
<dt> -bitdepth val:</dt><dd>
Specify the bit depth of the panchromatic and
spectral bands (e.g. 12). If not specified, the NBITS metadata item from the
panchromatic band will be used if it exists.</dd>
<dt> -nodata val:</dt><dd>
Specify nodata value for bands. Used for the resampling and pan-sharpening computation
itself. If not set, deduced from the input bands, provided they have a consistent
setting.</dd>
<dt> -spat_adjust
{union (default),intersection,none,nonewithoutwarning}:</dt><dd>
Select behaviour when bands have not the same extent. See SpatialExtentAdjustment
documentation in <a href="gdal_vrttut.html#gdal_vrttut_pansharpen">VRT tutorial</a></dd>
<dt> -co "NAME=VALUE":</dt><dd> Passes a creation option to the
output format driver. Multiple -co options may be listed. See <a class="el"
href="formats_list.html" title="GDAL Raster Formats">format specific
documentation for legal creation options for each format</a>.</dd>
<dt> -q:</dt><dd> Suppress progress monitor and other non-error
output.</dd>
<dt> pan_dataset</dt><dd> Dataset with panchromatic band (first band will be used).</dd>
<dt> spectral_dataset[,band=num]</dt><dd> Dataset with one or several spectral bands. If
the band option is not specified, all bands of the datasets are taken into account. Otherwise,
only the specified (num)th band. The same dataset can be repeated several times.</dd>
<dt> out_dataset</dt><dd> Output dataset</dd>
</dl>

Bands should be in the same projection.

\section gdal_pansharpen_example EXAMPLE

With spectral bands in a single dataset :
\verbatim
gdal_pansharpen.py panchro.tif multispectral.tif pansharpened_out.tif
\endverbatim

With a few spectral bands from a single dataset, reordered :
\verbatim
gdal_pansharpen.py panchro.tif multispectral.tif,band=3 multispectral.tif,band=2 multispectral.tif,band=1 pansharpened_out.tif
\endverbatim

With spectral bands in several datasets :
\verbatim
gdal_pansharpen.py panchro.tif band1.tif band2.tif band3.tif pansharpened_out.tif
\endverbatim

Specify weights:
\verbatim
gdal_pansharpen.py -w 0.7 -w 0.2 -w 0.1 panchro.tif multispectral.tif pansharpened_out.tif
\endverbatim

Specify RGB bands from a RGBNir multispectral dataset while computing the pseudo panchromatic intensity on the 4 RGBNir bands:
\verbatim
gdal_pansharpen.py -b 1 -b 2 -b 3 panchro.tif rgbnir.tif pansharpened_out.tif
\endverbatim

\if man
\section gdal_pansharpen_author AUTHORS
Even Rouault <even.rouault at spatialys.com>
\endif
*/