 |
|
| |
GDAL-RASTER-CLIP(1) |
GDAL |
GDAL-RASTER-CLIP(1) |
gdal-raster-clip - Clip a raster dataset
Added in version 3.11.
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
--json-usage Display usage as JSON document and exit
--config <KEY>=<VALUE> Configuration option [may be repeated]
--progress Display progress bar
Options:
-f, --of, --format, --output-format <OUTPUT-FORMAT> Output format ("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 --geometry, --like
--bbox-crs <BBOX-CRS> CRS of clipping bounding box
--geometry <GEOMETRY> Clipping geometry (WKT or GeoJSON)
Mutually exclusive with --bbox, --like
--geometry-crs <GEOMETRY-CRS> CRS of clipping geometry
--like <DATASET> Dataset to use as a template for bounds
Mutually exclusive with --bbox, --geometry
--like-sql <SELECT-STATEMENT> SELECT statement to run on the 'like' dataset
Mutually exclusive with --like-where
--like-layer <LAYER-NAME> Name of the layer of the 'like' dataset
--like-where <WHERE-EXPRESSION> WHERE SQL clause to run on the 'like' dataset
Mutually exclusive with --like-sql
--only-bbox For 'geometry' and 'like', only consider their bounding box
--allow-bbox-outside-source Allow clipping box to include pixels outside input dataset
--add-alpha Adds an alpha mask band to the destination when the source raster have none.
Advanced Options:
--if, --input-format <INPUT-FORMAT> Input formats [may be repeated]
--oo, --open-option <KEY>=<VALUE> Open options [may be repeated]
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.
- --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.
- --geometry
<WKT_or_GeoJSON>
- Geometry as a WKT or GeoJSON string of a polygon (or multipolygon) to
which to clip the dataset. Raster areas within the bounding box of the
geometry but not inside the geometry itself will be set to the nodata
value of the raster, or 0 if there is none. All pixels overlapping the
geometry will be selected. If the input geometry is GeoJSON, its CRS is
assumed to be WGS84, unless there is a CRS defined in the GeoJSON geometry
or --geometry-crs is specified. If the input geometry is WKT, its
CRS is assumed to be the one of the input dataset, unless
--geometry-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. Mutually exclusive with --bbox and --like.
- --geometry-crs
<CRS>
- CRS in which the coordinates values of --geometry are expressed. If
not specified, it is assumed to be the CRS of the input dataset. The
bounds are reprojected from the geometry-crs to the CRS of the input
dataset.
- --like
<DATASET>
- Vector or raster dataset to use as a template for bounds. If the specified
dataset is a raster, its rectangular bounds are used as the clipping
geometry. If the specified dataset is a vector dataset, its polygonal
geometries are unioned together to form the clipping geometry. If several
layers are present, --like-sql or --like-layer must be
specified. Raster areas within the bounding box of the geometry but not
inside the geometry itself will be set to the nodata value of the raster,
or 0 if there is none. Mutually exclusive with --bbox and
--geometry.
- --like-sql
<SELECT-STATEMENT>
- Select desired geometries from the vector clip dataset using an SQL query.
e.g SELECT geom FROM my_layer WHERE country = 'France'. The SQL
dialect used will be the default one of the like dataset (OGR SQL
for Shapefile, SQLite for GeoPackage, PostgreSQL for PostGIS, etc.).
Mutually exclusive with --like-layer and --like-where
- --only-bbox
- For --geometry and --like, only consider the bounding box of
the geometry.
- --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.
- --addalpha
- Adds an alpha mask band to the destination when the source raster has
none.
- --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.
$ gdal raster clip --bbox=2,49,3,50 --bbox-crs=EPSG:4326 in.tif out.tif --overwrite
$ gdal raster clip --like=reference.tif in.tif out.tif --overwrite
Even Rouault <even.rouault@spatialys.com>
Visit the GSP FreeBSD Man Page Interface. Output converted with ManDoc.
|