R/sagang_burnstreamnetworkintodem.R
sagang_burnstreamnetworkintodem.Rd
QGIS Algorithm provided by SAGA Next Gen Burn stream network into dem (sagang:burnstreamnetworkintodem). —————- Arguments —————- DEM: DEM Argument type: raster Acceptable values: - Path to a raster layer BURN: Processed DEM Argument type: rasterDestination Acceptable values: - Path for new raster layer STREAM: Streams Argument type: raster Acceptable values: - Path to a raster layer FLOWDIR: Flow Direction Argument type: raster Acceptable values: - Path to a raster layer METHOD: Method Default value: 0 Argument type: enum Available values: - 0: (0) simply decrease cell's value by epsilon - 1: (1) lower cell's value to neighbours minimum value minus epsilon - 2: (2) trace stream network downstream Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' EPSILON: Epsilon 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
sagang_burnstreamnetworkintodem(
DEM = qgisprocess:::qgis_default_value(),
BURN = qgisprocess:::qgis_default_value(),
STREAM = qgisprocess:::qgis_default_value(),
FLOWDIR = qgisprocess:::qgis_default_value(),
METHOD = qgisprocess:::qgis_default_value(),
EPSILON = qgisprocess:::qgis_default_value(),
...,
.complete_output = .complete_output_option(),
.quiet = .quiet_option(),
.messages = .message_option()
)
raster
- DEM. Path to a raster layer.
rasterDestination
- Processed DEM. Path for new raster layer.
raster
- Streams. Path to a raster layer.
raster
- Flow Direction. Path to a raster layer.
enum
of ("(0) simply decrease cell's value by epsilon", "(1) lower cell's value to neighbours minimum value minus epsilon", "(2) trace stream network downstream")
- Method. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
number
- Epsilon. 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.
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
.