qgis_virtualrastercalc: QGIS algorithm - Raster calculator (virtual)

View source: R/qgis_virtualrastercalc.R

qgis_virtualrastercalcR Documentation

QGIS algorithm - Raster calculator (virtual)

Description

QGIS Algorithm provided by QGIS (native c++) Raster calculator (virtual) (native:virtualrastercalc). Performs algebraic operations using raster layers and generates in-memory result.

Usage

qgis_virtualrastercalc(
  LAYERS = qgisprocess:::qgis_default_value(),
  EXPRESSION = qgisprocess:::qgis_default_value(),
  EXTENT = qgisprocess:::qgis_default_value(),
  CELL_SIZE = qgisprocess:::qgis_default_value(),
  CRS = qgisprocess:::qgis_default_value(),
  LAYER_NAME = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

LAYERS

multilayer - Input layers. .

EXPRESSION

expression - Expression. A valid QGIS expression string, e.g "road_name" = 'MAIN RD'.

EXTENT

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

CELL_SIZE

number - Output cell size (leave empty to set automatically). 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.

CRS

crs - Output 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..

LAYER_NAME

string - Output layer name. 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.

...

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 Nov. 3, 2024, 5:25 p.m.