gdal_rastercalculator: QGIS algorithm Raster calculator

View source: R/gdal_rastercalculator.R

gdal_rastercalculatorR Documentation

QGIS algorithm Raster calculator

Description

QGIS Algorithm provided by GDAL Raster calculator (gdal:rastercalculator)

Usage

gdal_rastercalculator(
  INPUT_A = qgisprocess::qgis_default_value(),
  BAND_A = qgisprocess::qgis_default_value(),
  INPUT_B = qgisprocess::qgis_default_value(),
  BAND_B = qgisprocess::qgis_default_value(),
  INPUT_C = qgisprocess::qgis_default_value(),
  BAND_C = qgisprocess::qgis_default_value(),
  INPUT_D = qgisprocess::qgis_default_value(),
  BAND_D = qgisprocess::qgis_default_value(),
  INPUT_E = qgisprocess::qgis_default_value(),
  BAND_E = qgisprocess::qgis_default_value(),
  INPUT_F = qgisprocess::qgis_default_value(),
  BAND_F = qgisprocess::qgis_default_value(),
  FORMULA = qgisprocess::qgis_default_value(),
  NO_DATA = qgisprocess::qgis_default_value(),
  RTYPE = qgisprocess::qgis_default_value(),
  OPTIONS = 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_A

raster - Input layer A. Path to a raster layer.

BAND_A

band - Number of raster band for A. Integer value representing an existing raster band number.

INPUT_B

raster - Input layer B. Path to a raster layer.

BAND_B

band - Number of raster band for B. Integer value representing an existing raster band number.

INPUT_C

raster - Input layer C. Path to a raster layer.

BAND_C

band - Number of raster band for C. Integer value representing an existing raster band number.

INPUT_D

raster - Input layer D. Path to a raster layer.

BAND_D

band - Number of raster band for D. Integer value representing an existing raster band number.

INPUT_E

raster - Input layer E. Path to a raster layer.

BAND_E

band - Number of raster band for E. Integer value representing an existing raster band number.

INPUT_F

raster - Input layer F. Path to a raster layer.

BAND_F

band - Number of raster band for F. Integer value representing an existing raster band number.

FORMULA

string - Calculation in gdalnumeric syntax using +-/* or any numpy array functions (i.e. logical_and()). String value.

NO_DATA

number - Set output nodata value. A numeric value.

RTYPE

enum of ("Byte", "Int16", "UInt16", "UInt32", "Int32", "Float32", "Float64") - Output raster type. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

OPTIONS

string - Additional creation options. String value.

EXTRA

string - Additional command-line parameters. String value.

OUTPUT

rasterDestination - Calculated. 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 - Calculated


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