sagang_upslopearea: QGIS algorithm - Upslope area

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

QGIS algorithm - Upslope area

Description

QGIS Algorithm provided by SAGA Next Gen Upslope area (sagang:upslopearea). —————- Arguments —————- TARGET: Target Area (optional) Argument type: raster Acceptable values: - Path to a raster layer TARGET_PT_X: Target X coordinate Default value: 0 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 TARGET_PT_Y: Target Y coordinate Default value: 0 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 ELEVATION: Elevation Argument type: raster Acceptable values: - Path to a raster layer SINKROUTE: Sink Routes (optional) Argument type: raster Acceptable values: - Path to a raster layer AREA: Upslope Area 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) Deterministic Infinity - 2: (2) Multiple Flow Direction - 3: (3) Multiple Triangular Flow Directon - 4: (4) Multiple Maximum Downslope Gradient Based Flow Directon Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' CONVERGE: Convergence Default value: 1.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

Usage

sagang_upslopearea(
  TARGET = qgisprocess:::qgis_default_value(),
  TARGET_PT_X = qgisprocess:::qgis_default_value(),
  TARGET_PT_Y = qgisprocess:::qgis_default_value(),
  ELEVATION = qgisprocess:::qgis_default_value(),
  SINKROUTE = qgisprocess:::qgis_default_value(),
  AREA = qgisprocess:::qgis_default_value(),
  METHOD = qgisprocess:::qgis_default_value(),
  CONVERGE = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

TARGET	raster - Target Area. Path to a raster layer.
TARGET_PT_X	number - Target X coordinate. 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.
TARGET_PT_Y	number - Target Y coordinate. 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.
ELEVATION	raster - Elevation. Path to a raster layer.
SINKROUTE	raster - Sink Routes. Path to a raster layer.
AREA	rasterDestination - Upslope Area. Path for new raster layer.
METHOD	enum of ⁠("(0) Deterministic 8", "(1) Deterministic Infinity", "(2) Multiple Flow Direction", "(3) Multiple Triangular Flow Directon", "(4) Multiple Maximum Downslope Gradient Based Flow Directon")⁠ - Method. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
CONVERGE	number - Convergence. 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()
.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

• AREA - outputRaster - Upslope Area

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