sagang_flowwidthandspecificcatchmentarea: QGIS algorithm - Flow width and specific catchment area

View source: R/sagang_flowwidthandspecificcatchmentarea.R

sagang_flowwidthandspecificcatchmentareaR Documentation

QGIS algorithm - Flow width and specific catchment area

Description

QGIS Algorithm provided by SAGA Next Gen Flow width and specific catchment area (sagang:flowwidthandspecificcatchmentarea). —————- Arguments —————- DEM: Elevation Argument type: raster Acceptable values: - Path to a raster layer WIDTH: Flow Width Argument type: rasterDestination Acceptable values: - Path for new raster layer TCA: Total Catchment Area (TCA) (optional) Argument type: raster Acceptable values: - Path to a raster layer SCA: Specific Catchment Area (SCA) Argument type: rasterDestination Acceptable values: - Path for new raster layer METHOD: Method Default value: 2 Argument type: enum Available values: - 0: (0) Deterministic 8 - 1: (1) Multiple Flow Direction (Quinn et al. 1991) - 2: (2) Aspect Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3'

Usage

sagang_flowwidthandspecificcatchmentarea(
  DEM = qgisprocess:::qgis_default_value(),
  WIDTH = qgisprocess:::qgis_default_value(),
  TCA = qgisprocess:::qgis_default_value(),
  SCA = qgisprocess:::qgis_default_value(),
  METHOD = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

DEM

raster - Elevation. Path to a raster layer.

WIDTH

rasterDestination - Flow Width. Path for new raster layer.

TCA

raster - Total Catchment Area (TCA). Path to a raster layer.

SCA

rasterDestination - Specific Catchment Area (SCA). Path for new raster layer.

METHOD

enum of ⁠("(0) Deterministic 8", "(1) Multiple Flow Direction (Quinn et al. 1991)", "(2) Aspect")⁠ - Method. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

...

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

  • SCA - outputRaster - Specific Catchment Area (SCA)

  • WIDTH - outputRaster - Flow Width


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