gdal_cliprasterbyextent: QGIS algorithm Clip raster by extent

View source: R/gdal_cliprasterbyextent.R

gdal_cliprasterbyextentR Documentation

QGIS algorithm Clip raster by extent

Description

QGIS Algorithm provided by GDAL Clip raster by extent (gdal:cliprasterbyextent)

Usage

gdal_cliprasterbyextent(
  INPUT = qgisprocess::qgis_default_value(),
  PROJWIN = qgisprocess::qgis_default_value(),
  OVERCRS = qgisprocess::qgis_default_value(),
  NODATA = 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.

PROJWIN

extent - Clipping 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..

OVERCRS

boolean - Override the projection for the output file. 1 for true/yes. 0 for false/no.

NODATA

number - Assign a specified nodata value to output bands. A numeric value.

OPTIONS

string - Additional creation options. String value.

DATA_TYPE

enum of ("Use Input Layer Data Type", "Byte", "Int16", "UInt16", "UInt32", "Int32", "Float32", "Float64", "CInt16", "CInt32", "CFloat32", "CFloat64") - 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.

OUTPUT

rasterDestination - Clipped (extent). 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 (extent)


JanCaha/r_package_qgis documentation built on March 7, 2023, 7:17 a.m.