sagang_cellbalance: QGIS algorithm - Cell balance

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

QGIS algorithm - Cell balance

Description

QGIS Algorithm provided by SAGA Next Gen Cell balance (sagang:cellbalance). —————- Arguments —————- DEM: Elevation Argument type: raster Acceptable values: - Path to a raster layer WEIGHTS: Weights (optional) Argument type: raster Acceptable values: - Path to a raster layer WEIGHTS_DEFAULT: Default 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 BALANCE: Cell Balance Argument type: rasterDestination Acceptable values: - Path for new raster layer METHOD: Method Default value: 1 Argument type: enum Available values: - 0: (0) Deterministic 8 - 1: (1) Multiple Flow Direction Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3'

Usage

sagang_cellbalance(
  DEM = qgisprocess:::qgis_default_value(),
  WEIGHTS = qgisprocess:::qgis_default_value(),
  WEIGHTS_DEFAULT = qgisprocess:::qgis_default_value(),
  BALANCE = 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.
WEIGHTS	raster - Weights. Path to a raster layer.
WEIGHTS_DEFAULT	number - Default. 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.
BALANCE	rasterDestination - Cell Balance. Path for new raster layer.
METHOD	enum of ⁠("(0) Deterministic 8", "(1) Multiple Flow Direction")⁠ - 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

• BALANCE - outputRaster - Cell Balance

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