sagang_wetness: QGIS algorithm - Wetness

In JanCaha/r_package_qgis: An extension of package "qgisprocess" providing direct R functions for QGIS functions

QGIS algorithm - Wetness

Description

QGIS Algorithm provided by SAGA Next Gen Wetness (sagang:wetness). —————- Arguments —————- DEM: DEM Argument type: raster Acceptable values: - Path to a raster layer Cmin: Min hydraulic conductivity grid (m/hr) (optional) Argument type: raster Acceptable values: - Path to a raster layer Cmax: Max hydraulic conductivity grid (m/hr) (optional) Argument type: raster Acceptable values: - Path to a raster layer Dmin: Min groundwater recharge grid (m/hr) (optional) Argument type: raster Acceptable values: - Path to a raster layer Dmax: Max groundwater recharge grid (m/hr) (optional) Argument type: raster Acceptable values: - Path to a raster layer Emin: Min material depth grid (m) (optional) Argument type: raster Acceptable values: - Path to a raster layer Emax: Max material depth grid (m) (optional) Argument type: raster Acceptable values: - Path to a raster layer fCmin: Min global material conductivity (m/hr) Default value: 2.7 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 fCmax: Max global material conductivity (m/hr) Default value: 2.7 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 fDmin: Min global groundwater recharge (m/hr) Default value: 0.001 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 fDmax: Max global groundwater recharge (m/hr) Default value: 0.001 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 fEmin: Min global material depth (m) Default value: 1 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 fEmax: Max global material depth (m) Default value: 1 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 fH: Parameter sampling runs Default value: 1 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 F: WI values Argument type: rasterDestination Acceptable values: - Path for new raster layer G: WI classes Argument type: rasterDestination Acceptable values: - Path for new raster layer METHOD: Catchment Area Calculation Default value: 4 Argument type: enum Available values: - 0: (0) Deterministic 8 - 1: (1) Rho 8 - 2: (2) Braunschweiger Reliefmodell - 3: (3) Deterministic Infinity - 4: (4) Multiple Flow Direction - 5: (5) Multiple Triangular Flow Directon Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' PREPROC: Preprocessing 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_wetness(
  DEM = qgisprocess:::qgis_default_value(),
  Cmin = qgisprocess:::qgis_default_value(),
  Cmax = qgisprocess:::qgis_default_value(),
  Dmin = qgisprocess:::qgis_default_value(),
  Dmax = qgisprocess:::qgis_default_value(),
  Emin = qgisprocess:::qgis_default_value(),
  Emax = qgisprocess:::qgis_default_value(),
  fCmin = qgisprocess:::qgis_default_value(),
  fCmax = qgisprocess:::qgis_default_value(),
  fDmin = qgisprocess:::qgis_default_value(),
  fDmax = qgisprocess:::qgis_default_value(),
  fEmin = qgisprocess:::qgis_default_value(),
  fEmax = qgisprocess:::qgis_default_value(),
  fH = qgisprocess:::qgis_default_value(),
  F = qgisprocess:::qgis_default_value(),
  G = qgisprocess:::qgis_default_value(),
  METHOD = qgisprocess:::qgis_default_value(),
  PREPROC = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

DEM	raster - DEM. Path to a raster layer.
Cmin	raster - Min hydraulic conductivity grid (m/hr) . Path to a raster layer.
Cmax	raster - Max hydraulic conductivity grid (m/hr) . Path to a raster layer.
Dmin	raster - Min groundwater recharge grid (m/hr) . Path to a raster layer.
Dmax	raster - Max groundwater recharge grid (m/hr) . Path to a raster layer.
Emin	raster - Min material depth grid (m). Path to a raster layer.
Emax	raster - Max material depth grid (m). Path to a raster layer.
fCmin	number - Min global material conductivity (m/hr). 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.
fCmax	number - Max global material conductivity (m/hr). 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.
fDmin	number - Min global groundwater recharge (m/hr). 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.
fDmax	number - Max global groundwater recharge (m/hr). 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.
fEmin	number - Min global material depth (m). 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.
fEmax	number - Max global material depth (m). 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.
fH	number - Parameter sampling runs. 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.
F	rasterDestination - WI values. Path for new raster layer.
G	rasterDestination - WI classes. Path for new raster layer.
METHOD	enum of ⁠("(0) Deterministic 8", "(1) Rho 8", "(2) Braunschweiger Reliefmodell", "(3) Deterministic Infinity", "(4) Multiple Flow Direction", "(5) Multiple Triangular Flow Directon")⁠ - Catchment Area Calculation. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
PREPROC	boolean - Preprocessing. 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

• F - outputRaster - WI values

• G - outputRaster - WI classes

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