"gdal raster clip" sub-command
Added in version 3.11.
Clip a raster dataset.
Synopsis
Usage: gdal raster clip [OPTIONS] <INPUT> <OUTPUT>
Clip a raster dataset.
Positional arguments:
-i, --input <INPUT> Input raster dataset [required]
-o, --output <OUTPUT> Output raster dataset [required]
Common Options:
-h, --help Display help message and exit
--version Display GDAL version and exit
--json-usage Display usage as JSON document and exit
--drivers Display driver list as JSON document and exit
--config <KEY>=<VALUE> Configuration option [may be repeated]
--progress Display progress bar
Options:
-f, --of, --format, --output-format <OUTPUT-FORMAT> Output format ("GDALG" allowed)
--co, --creation-option <KEY>=<VALUE> Creation option [may be repeated]
--overwrite Whether overwriting existing output is allowed
--bbox <BBOX> Clipping bounding box as xmin,ymin,xmax,ymax
Mutually exclusive with --like
--bbox-crs <BBOX-CRS> CRS of clipping bounding box
--like <DATASET> Raster dataset to use as a template for bounds
Mutually exclusive with --bbox
--allow-bbox-outside-source Allow clipping box to include pixels outside input dataset
Advanced Options:
--if, --input-format <INPUT-FORMAT> Input formats [may be repeated]
--oo, --open-option <KEY=VALUE> Open options [may be repeated]
Description
gdal raster clip can be used to clip a raster dataset using georeferenced coordinates.
Either --bbox
or --like
must be specified.
The output dataset is in the same SRS as the input one, and the original resolution is preserved. Bounds are rounded to match whole pixel locations (i.e. there is no resampling involved)
clip
can also be used as a step of "gdal raster pipeline" sub-command.
Standard options
- -f, --of, --format, --output-format <OUTPUT-FORMAT>
Which output raster format to use. Allowed values may be given by
gdal --formats | grep raster | grep rw | sort
- --co <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.
- --overwrite
Allow program to overwrite existing target file or dataset. Otherwise, by default, gdal errors out if the target file or dataset already exists.
- --bbox <xmin>,<ymin>,<xmax>,<ymax>
Bounds to which to clip the dataset. They are assumed to be in the CRS of the input dataset, unless
--bbox-crs
is specified. The X and Y axis are the "GIS friendly ones", that is X is longitude or easting, and Y is latitude or northing. The bounds are expanded if necessary to match input pixel boundaries. By default, gdal raster clip will produce an error if the bounds indicated by--bbox
are greater than the extents of input dataset. This check can be bypassed using--allow-bbox-outside-source
.
- --bbox-crs <CRS>
CRS in which the <xmin>,<ymin>,<xmax>,<ymax> values of
--bbox
are expressed. If not specified, it is assumed to be the CRS of the input dataset. Note that specifying--bbox-crs
does not cause the raster to be reprojected. Instead, the bounds are reprojected from the bbox-crs to the CRS of the input dataset.
- --allow-bbox-outside-source
If set, allows the bounds indicated by
--bbox
to cover an extent that is greater than the input dataset. Output pixels from areas beyond the input extent will be set to zero or the NoData value of the input dataset.
- --like <DATASET>
Raster dataset to use as a template for bounds, forming a rectangular shape following the geotransformation matrix (and thus potentially including nodata collar). This option is mutually exclusive with
--bbox
and--bbox-crs
.
Advanced options
- --oo <NAME>=<VALUE>
Dataset open option (format specific).
May be repeated.
- --if <format>
Format/driver name to be attempted to open the input file(s). It is generally not necessary to specify it, but it can be used to skip automatic driver detection, when it fails to select the appropriate driver. This option can be repeated several times to specify several candidate drivers. Note that it does not force those drivers to open the dataset. In particular, some drivers have requirements on file extensions.
May be repeated.
Examples
Example 1: Clip a GeoTIFF file to the bounding box from longitude 2, latitude 49, to longitude 3, latitude 50 in WGS 84
$ gdal raster clip --bbox=2,49,3,50 --bbox-crs=EPSG:4326 in.tif out.tif --overwrite
Example 2: Clip a GeoTIFF file using the bounds of reference.tif
$ gdal raster clip --like=reference.tif in.tif out.tif --overwrite