gdal:cliprasterbymasklayer
How QGIS runs Clip raster: gdal:cliprasterbymasklayer.
| Engine | QGIS |
|---|---|
| Tool name | gdal:cliprasterbymasklayer |
| Interface | qgis-process |
| Implements | Clip raster |
| Documentation | Not stated |
| Effects | modifies input: no, network: no |
| Notes | Not stated |
| Status | active |
Parameters
| Name | Type | Required | Default | Choices | Note |
|---|---|---|---|---|---|
ALPHA_BAND | boolean | yes | no | Not stated | Not stated |
CREATION_OPTIONS | string | no | Not stated | Not stated | Not stated |
CROP_TO_CUTLINE | boolean | yes | yes | Not stated | Not stated |
DATA_TYPE | enum | yes | 0 | 0, 1, 10, 11, 12, 2, 3, 4, 5, 6, 7, 8, 9 | 0 Use Input Layer Data Type, 1 Byte, 10 CFloat32, 11 CFloat64, 12 Int8, 2 Int16, 3 UInt16, 4 UInt32, 5 Int32, 6 Float32, 7 Float64, 8 CInt16, 9 CInt32 |
EXTRA | string | no | Not stated | Not stated | Not stated |
INPUT | raster | yes | Not stated | Not stated | Not stated |
KEEP_RESOLUTION | boolean | yes | no | Not stated | Not stated |
MASK | source | yes | Not stated | Not stated | Not stated |
MULTITHREADING | boolean | yes | no | Not stated | Not stated |
NODATA | number | no | Not stated | Not stated | Not stated |
OUTPUT | rasterDestination | yes | Not stated | Not stated | output |
SET_RESOLUTION | boolean | yes | no | Not stated | Not stated |
SOURCE_CRS | crs | no | Not stated | Not stated | Not stated |
TARGET_CRS | crs | no | Not stated | Not stated | Not stated |
TARGET_EXTENT | extent | no | Not stated | Not stated | Not stated |
X_RESOLUTION | number | no | Not stated | Not stated | Not stated |
Y_RESOLUTION | number | no | Not stated | Not stated | Not stated |
How it maps to the operation
| Operation parameter | Parameter here | Note |
|---|---|---|
raster | INPUT | Not stated |
mask | MASK | Not stated |
output | OUTPUT | Not stated |
Differences from the operation
- Runs GDAL's warp underneath; CROP_TO_CUTLINE (on by default) shrinks the output to the mask's extent.
Harvested by the qgis harvester from engine version
4.2.3. Names can change when an engine is harvested again.