gdal_cliprasterbymasklayer: QGIS algorithm - Clip raster by mask layer

In JanCaha/r_package_qgis: An extension of package "qgisprocess" providing direct R functions for QGIS functions

QGIS algorithm - Clip raster by mask layer

Description

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

Usage

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()
)

Arguments

INPUT	raster - Input layer. Path to a raster layer.
MASK	source - Mask layer. Path to a vector layer.
SOURCE_CRS	crs - Source CRS. 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	crs - Target CRS. 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	extent - Target extent. 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	number - Assign a specified NoData value to output bands. 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	boolean - Create an output alpha band. 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	boolean - Match the extent of the clipped raster to the extent of the mask layer. 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	boolean - Keep resolution of input raster. 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	boolean - Set output file resolution. 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	number - X Resolution to output bands. 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	number - Y Resolution to output bands. 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	boolean - Use multithreaded warping implementation. 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	string - Additional creation options. 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	enum of ⁠("Use Input Layer Data Type", "Byte", "Int16", "UInt16", "UInt32", "Int32", "Float32", "Float64", "CInt16", "CInt32", "CFloat32", "CFloat64", "Int8")⁠ - Output data type. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
EXTRA	string - Additional command-line parameters. 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	rasterDestination - Clipped (mask). Path for new raster layer.
...	further parameters passed to qgisprocess::qgis_run_algorithm()
.complete_output	logical specifying if complete out of qgisprocess::qgis_run_algorithm() should be used (TRUE) or first output (most likely the main) should read (FALSE). Default value is TRUE.
.quiet	logical specifying if parameter .quiet for qgisprocess::qgis_run_algorithm() Default value is TRUE.
.messages	logical specifying if messages from qgisprocess::qgis_run_algorithm() should be printed (TRUE) or not (FALSE). Default value is FALSE.

Details

Outputs description

• OUTPUT - outputRaster - Clipped (mask)

JanCaha/r_package_qgis documentation built on April 12, 2025, 10:51 a.m.