View source: R/gdal_cliprasterbymasklayer.R
gdal_cliprasterbymasklayer | R Documentation |
QGIS Algorithm provided by GDAL Clip raster by mask layer (gdal:cliprasterbymasklayer). —————- Arguments —————- INPUT: Input layer Argument type: raster Acceptable values: - Path to a raster layer MASK: Mask layer Argument type: source Acceptable values: - Path to a vector layer SOURCE_CRS: Source CRS (optional) Argument type: crs Acceptable values: - CRS as an auth ID (e.g. 'EPSG:3111') - CRS as a PROJ4 string (e.g. 'PROJ4:…') - CRS as a WKT string (e.g. 'WKT:…') - Path to a layer. The CRS of the layer is used. TARGET_CRS: Target CRS (optional) Argument type: crs Acceptable values: - CRS as an auth ID (e.g. 'EPSG:3111') - CRS as a PROJ4 string (e.g. 'PROJ4:…') - CRS as a WKT string (e.g. 'WKT:…') - Path to a layer. The CRS of the layer is used. TARGET_EXTENT: Target extent (optional) Argument type: extent Acceptable values: - A comma delimited string of x min, x max, y min, y max. E.g. '4,10,101,105' - Path to a layer. The extent of the layer is used. NODATA: Assign a specified NoData value to output bands (optional) Argument type: number Acceptable values: - A numeric value - field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field - expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression ALPHA_BAND: Create an output alpha band Default value: false Argument type: boolean Acceptable values: - 1 for true/yes - 0 for false/no - field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field - expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression CROP_TO_CUTLINE: Match the extent of the clipped raster to the extent of the mask layer Default value: true Argument type: boolean Acceptable values: - 1 for true/yes - 0 for false/no - field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field - expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression KEEP_RESOLUTION: Keep resolution of input raster Default value: false Argument type: boolean Acceptable values: - 1 for true/yes - 0 for false/no - field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field - expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression SET_RESOLUTION: Set output file resolution Default value: false Argument type: boolean Acceptable values: - 1 for true/yes - 0 for false/no - field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field - expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression X_RESOLUTION: X Resolution to output bands (optional) Argument type: number Acceptable values: - A numeric value - field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field - expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression Y_RESOLUTION: Y Resolution to output bands (optional) Argument type: number Acceptable values: - A numeric value - field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field - expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression MULTITHREADING: Use multithreaded warping implementation Default value: false Argument type: boolean Acceptable values: - 1 for true/yes - 0 for false/no - field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field - expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression OPTIONS: Additional creation options (optional) Default value: Argument type: string Acceptable values: - String value - field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field - expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression DATA_TYPE: Output data type Default value: 0 Argument type: enum Available values: - 0: Use Input Layer Data Type - 1: Byte - 2: Int16 - 3: UInt16 - 4: UInt32 - 5: Int32 - 6: Float32 - 7: Float64 - 8: CInt16 - 9: CInt32 - 10: CFloat32 - 11: CFloat64 - 12: Int8 Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' EXTRA: Additional command-line parameters (optional) Argument type: string Acceptable values: - String value - field:FIELD_NAME to use a data defined value taken from the FIELD_NAME field - expression:SOME EXPRESSION to use a data defined value calculated using a custom QGIS expression OUTPUT: Clipped (mask) Argument type: rasterDestination Acceptable values: - Path for new raster layer
gdal_cliprasterbymasklayer(
INPUT = qgisprocess:::qgis_default_value(),
MASK = qgisprocess:::qgis_default_value(),
SOURCE_CRS = qgisprocess:::qgis_default_value(),
TARGET_CRS = qgisprocess:::qgis_default_value(),
TARGET_EXTENT = qgisprocess:::qgis_default_value(),
NODATA = qgisprocess:::qgis_default_value(),
ALPHA_BAND = qgisprocess:::qgis_default_value(),
CROP_TO_CUTLINE = qgisprocess:::qgis_default_value(),
KEEP_RESOLUTION = qgisprocess:::qgis_default_value(),
SET_RESOLUTION = qgisprocess:::qgis_default_value(),
X_RESOLUTION = qgisprocess:::qgis_default_value(),
Y_RESOLUTION = qgisprocess:::qgis_default_value(),
MULTITHREADING = qgisprocess:::qgis_default_value(),
OPTIONS = qgisprocess:::qgis_default_value(),
DATA_TYPE = qgisprocess:::qgis_default_value(),
EXTRA = qgisprocess:::qgis_default_value(),
OUTPUT = qgisprocess:::qgis_default_value(),
...,
.complete_output = .complete_output_option(),
.quiet = .quiet_option(),
.messages = .message_option()
)
INPUT |
|
MASK |
|
SOURCE_CRS |
|
TARGET_CRS |
|
TARGET_EXTENT |
|
NODATA |
|
ALPHA_BAND |
|
CROP_TO_CUTLINE |
|
KEEP_RESOLUTION |
|
SET_RESOLUTION |
|
X_RESOLUTION |
|
Y_RESOLUTION |
|
MULTITHREADING |
|
OPTIONS |
|
DATA_TYPE |
|
EXTRA |
|
OUTPUT |
|
... |
further parameters passed to |
.complete_output |
logical specifying if complete out of |
.quiet |
logical specifying if parameter |
.messages |
logical specifying if messages from |
OUTPUT - outputRaster - Clipped (mask)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.