R/sagang_topographicwetnessindextwi.R
sagang_topographicwetnessindextwi.Rd
QGIS Algorithm provided by SAGA Next Gen Topographic wetness index (twi) (sagang:topographicwetnessindextwi). —————- Arguments —————- SLOPE: Slope Argument type: raster Acceptable values: - Path to a raster layer AREA: Catchment Area Argument type: raster Acceptable values: - Path to a raster layer TRANS: Transmissivity (optional) Argument type: raster Acceptable values: - Path to a raster layer TWI: Topographic Wetness Index Argument type: rasterDestination Acceptable values: - Path for new raster layer CONV: Area Conversion Default value: 0 Argument type: enum Available values: - 0: (0) no conversion (areas already given as specific catchment area) - 1: (1) 1 / cell size (pseudo specific catchment area) Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' METHOD: Method (TWI) Default value: 0 Argument type: enum Available values: - 0: (0) Standard - 1: (1) TOPMODEL Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3'
sagang_topographicwetnessindextwi(
SLOPE = qgisprocess:::qgis_default_value(),
AREA = qgisprocess:::qgis_default_value(),
TRANS = qgisprocess:::qgis_default_value(),
TWI = qgisprocess:::qgis_default_value(),
CONV = qgisprocess:::qgis_default_value(),
METHOD = qgisprocess:::qgis_default_value(),
...,
.complete_output = .complete_output_option(),
.quiet = .quiet_option(),
.messages = .message_option()
)
raster
- Slope. Path to a raster layer.
raster
- Catchment Area. Path to a raster layer.
raster
- Transmissivity. Path to a raster layer.
rasterDestination
- Topographic Wetness Index. Path for new raster layer.
enum
of ("(0) no conversion (areas already given as specific catchment area)", "(1) 1 / cell size (pseudo specific catchment area)")
- Area Conversion. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
enum
of ("(0) Standard", "(1) TOPMODEL")
- Method (TWI). Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
further parameters passed to qgisprocess::qgis_run_algorithm()
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
.
logical specifying if parameter .quiet
for qgisprocess::qgis_run_algorithm()
Default value is TRUE
.
logical specifying if messages from qgisprocess::qgis_run_algorithm()
should be printed (TRUE
) or not (FALSE
). Default value is FALSE
.