sagang_changeagridsnodatavalue: QGIS algorithm - Change a grid's no-data value

View source: R/sagang_changeagridsnodatavalue.R

sagang_changeagridsnodatavalueR Documentation

QGIS algorithm - Change a grid's no-data value

Description

QGIS Algorithm provided by SAGA Next Gen Change a grid's no-data value (sagang:changeagridsnodatavalue). —————- Arguments —————- GRID: Grid Argument type: raster Acceptable values: - Path to a raster layer OUTPUT: Changed Grid Argument type: rasterDestination Acceptable values: - Path for new raster layer TYPE: Type Default value: 0 Argument type: enum Available values: - 0: (0) single value - 1: (1) value range Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' VALUE: No-Data Value Default value: -99999 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 CHANGE: Change Values 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

Usage

sagang_changeagridsnodatavalue(
  GRID = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  TYPE = qgisprocess:::qgis_default_value(),
  VALUE = qgisprocess:::qgis_default_value(),
  CHANGE = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

GRID

raster - Grid. Path to a raster layer.

OUTPUT

rasterDestination - Changed Grid. Path for new raster layer.

TYPE

enum of ⁠("(0) single value", "(1) value range")⁠ - Type. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

VALUE

number - No-Data 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.

CHANGE

boolean - Change 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.

...

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 - Changed Grid


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