GDAL-RASTER-OVERVIEW-ADD(1)

NAME
gdal-raster-overview-add - Add overviews to a raster dataset

Added in version 3.11.

SYNOPSIS

    Usage: gdal raster overview add [OPTIONS] <INPUT>
    Adding overviews.
    Positional arguments:
      -i, --dataset, --input <INPUT>         Dataset (to be updated in-place, unless --external) [required]
    Common Options:
      -h, --help                             Display help message and exit
      --json-usage                           Display usage as JSON document and exit
      --config <KEY>=<VALUE>                 Configuration option [may be repeated]
      -q, --quiet                            Quiet mode (no progress bar or warning message) [not available in pipelines]
    Options:
      --overview-src <OVERVIEW-SRC>          Source overview dataset [may be repeated]
                                             Mutually exclusive with --levels
      --external                             Add external overviews
      -r, --resampling <RESAMPLING>          Resampling method. RESAMPLING=nearest|average|cubic|cubicspline|lanczos|bilinear|gauss|average_magphase|rms|mode
      --levels <LEVELS>                      Levels / decimation factors [may be repeated]
                                             Mutually exclusive with --overview-src
      --min-size <MIN-SIZE>                  Maximum width or height of the smallest overview level.
      --co, --creation-option <KEY>=<VALUE>  Overview creation option [may be repeated]
    Advanced Options:
      --oo, --open-option <KEY>=<VALUE>      Open options [may be repeated]

DESCRIPTION

gdal raster overview add can be used to build or rebuild overview images for most supported file formats with one of several downsampling algorithms.

Starting with GDAL 3.12, gdal raster overview add can be used as a step of a pipeline. In that case virtual overviews are generated at the output of the step, and can potentially be materialized in the final write step, when writing a GeoTIFF file with the COPY_SRC_OVERVIEWS creation option, or when writing to a COG (Cloud Optimized GeoTIFF) file.

PROGRAM-SPECIFIC OPTIONS

--co <NAME>=<VALUE>
    Added in version 3.12.

    Overview creation options. May be repeated.

    Many formats have one or more optional creation options that can be used to control particulars about the created overviews. Options available can be obtained by looking at the OverviewCreationOptionList returned by gdal --format <FORMAT-NAME>.

    Most formats will support external overviews in a GeoTIFF file in a side-car file of extension .ovr. You can consult the overview creation options for GeoTIFF.

--dataset <DATASET>
    Dataset name, to be updated in-place by default (unless --external is specified). Required for standalone execution, implicit when run as a pipeline step

--external
    Create external .ovr overviews as GeoTIFF files. Not available when run as a pipeline step.

--levels <level1,level2,...>
    A list of overview levels to build. Each overview level must be an integer value greater or equal to 2.

    When explicit levels are not specified,

•   If there are already existing overviews, the corresponding levels will be used to refresh them if no explicit levels are specified.

•   Otherwise, appropriate overview power-of-two factors will be selected until the smallest overview is smaller than the value of the --min-size switch.

    Mutually exclusive with --overview-src

--min-size <val>
    Maximum width or height of the smallest overview level. Only taken into account if explicit levels are not specified. Defaults to 256.

--overview-src <INPUT>
    Added in version 3.12.

    Add specified input raster datasets as overviews of the target dataset. Source overviews may come from any GDAL supported format, provided they have the same number of bands and geospatial extent than the target dataset.

    That mode is currently only implemented when the target dataset is in GeoTIFF format, or when using --external.

    Mutually exclusive with --levels

-r, --resampling {nearest|average|cubic|cubicspline|lanczos|bilinear|gauss|average_magphase|rms|mode}
    Select a resampling algorithm. The default is nearest, which is generally not appropriate if sub-pixel accuracy is desired.

    When refreshing existing TIFF overviews, the previously used method, as noted in the RESAMPLING metadata item of the overview, will be used if -r is not specified.

    The available methods are:

    nearest applies a nearest neighbour (simple sampling) resampler.

    average computes the average of all non-NODATA contributing pixels. This is a weighted average taking into account properly the weight of source pixels not contributing fully to the target pixel.

    bilinear applies a bilinear convolution kernel.

    cubic applies a cubic convolution kernel.

    cubicspline applies a B-Spline convolution kernel.

    lanczos applies a Lanczos windowed sinc convolution kernel.

    gauss 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.

    average_magphase averages complex data in mag/phase space.

    rms computes the root mean squared / quadratic mean of all non-NODATA contributing pixels

    mode selects the value which appears most often of all the sampled points.

STANDARD OPTIONS

--co, --creation-option <NAME>=<VALUE>
    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.

    May be repeated.

    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 --formats command line option but the documentation for the format is the definitive source of information on driver creation options. See Raster drivers format specific documentation for legal creation options for each format.

--oo, --open-option <NAME>=<VALUE>
    Dataset open option (format specific).

    May be repeated.

RETURN STATUS CODE

The program returns status code 0 in case of success, and non-zero in case of error (non-blocking errors emitted as warnings are considered as a successful execution).

EXAMPLES

  Example 1: Create overviews, embedded in the supplied TIFF file, with automatic computation of levels

    gdal raster overview add -r average abc.tif

  Example 2: Create overviews, embedded in the supplied TIFF file

    gdal raster overview add -r average --levels=2,4,8,16 abc.tif

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

    gdal raster overview add --external --levels=2,4,8,16 --co COMPRESS=YES erdas.img

  Example 4: 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 --external option to force the generation of external overview.

    gdal raster overview add --co OVERVIEW=JPEG --co PHOTOMETRIC=YCBCR \
                             --co INTERLEAVE=PIXEL rgb_dataset.ext 2 4 8 16

  Example 5: Create overviews for a specific subdataset

For example, one of potentially many raster layers in a GeoPackage (the "filename" parameter must be driver prefix, filename and subdataset name, like e.g. shown by gdalinfo):

    gdal raster overview add GPKG:file.gpkg:layer

  Example 6: Add 3 existing datasets at scale 1:25K, 1:50K and 1:100K as overviews of my.tif.

    gdal raster overview add --overview-src ovr_25k.tif --overview-src ovr_50k.tif --overview-src ovr_100k.tif --dataset my.tif

  Example 7: Create a COG file with non power-of-two overview levels.

    gdal pipeline read input.tif ! reproject --output-crs=EPSG:4326 ! add overview --levels 16,64,128 ! write output.tif --format=COG

AUTHOR
Even Rouault <even.rouault@spatialys.com>

COPYRIGHT
1998-2026