qgis_reclassifybylayer: QGIS algorithm - Reclassify by layer

View source: R/qgis_reclassifybylayer.R

qgis_reclassifybylayerR Documentation

QGIS algorithm - Reclassify by layer

Description

QGIS Algorithm provided by QGIS (native c++) Reclassify by layer (native:reclassifybylayer). This algorithm reclassifies a raster band by assigning new class values based on the ranges specified in a vector table.

Usage

qgis_reclassifybylayer(
  INPUT_RASTER = qgisprocess:::qgis_default_value(),
  RASTER_BAND = qgisprocess:::qgis_default_value(),
  INPUT_TABLE = qgisprocess:::qgis_default_value(),
  MIN_FIELD = qgisprocess:::qgis_default_value(),
  MAX_FIELD = qgisprocess:::qgis_default_value(),
  VALUE_FIELD = qgisprocess:::qgis_default_value(),
  NO_DATA = qgisprocess:::qgis_default_value(),
  RANGE_BOUNDARIES = qgisprocess:::qgis_default_value(),
  NODATA_FOR_MISSING = qgisprocess:::qgis_default_value(),
  DATA_TYPE = qgisprocess:::qgis_default_value(),
  CREATE_OPTIONS = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT_RASTER

raster - Raster layer. Path to a raster layer.

RASTER_BAND

band - Band number. Integer value representing an existing raster band number.

INPUT_TABLE

source - Layer containing class breaks. Path to a vector layer.

MIN_FIELD

field - Minimum class value field. The name of an existing field. ; delimited list of existing field names.

MAX_FIELD

field - Maximum class value field. The name of an existing field. ; delimited list of existing field names.

VALUE_FIELD

field - Output value field. The name of an existing field. ; delimited list of existing field names.

NO_DATA

number - Output NoData value. 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.

RANGE_BOUNDARIES

enum of ⁠("min value = max", "min = value max", "min = value = max", "min value max")⁠ - Range boundaries. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

NODATA_FOR_MISSING

boolean - Use NoData when no range matches value. 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.

DATA_TYPE

enum of ⁠("Byte", "Int16", "UInt16", "Int32", "UInt32", "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'.

CREATE_OPTIONS

string - 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.

OUTPUT

rasterDestination - Reclassified raster. 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 - Reclassified raster


JanCaha/r_package_qgis documentation built on Nov. 3, 2024, 5:25 p.m.