sagang_riverbasin: QGIS algorithm - Riverbasin

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

QGIS algorithm - Riverbasin

Description

QGIS Algorithm provided by SAGA Next Gen Riverbasin (sagang:riverbasin). —————- Arguments —————- INPUT: DTM Argument type: raster Acceptable values: - Path to a raster layer INPUT2: HGGrid Argument type: raster Acceptable values: - Path to a raster layer INPUT3: statisches Entnahmeraster (optional) Argument type: raster Acceptable values: - Path to a raster layer WCons: Anteilige Flaechenwasserentnahme Default value: false Argument type: boolean Acceptable values: - 1 for true/yes - 0 for false/no - 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 WCons2: Dynamische Flaechenwassernutzung... Default value: 0 Argument type: enum Available values: - 0: (0) ...anteilig aus den Flussrasterzellen - 1: (1) ...anteilig aus Rasterzellen der Teileinzugegebiete Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' OUTPUT2: Grad Argument type: rasterDestination Acceptable values: - Path for new raster layer OUTPUT3: Direc Argument type: rasterDestination Acceptable values: - Path for new raster layer OUTPUT4: HGGrad Argument type: rasterDestination Acceptable values: - Path for new raster layer OUTPUT5: RivSpeed Argument type: rasterDestination Acceptable values: - Path for new raster layer OUTPUT6: Coordinates Argument type: rasterDestination Acceptable values: - Path for new raster layer OUTPUT7: BasinShare Argument type: rasterDestination Acceptable values: - Path for new raster layer OUTPUT8: statWUse Argument type: rasterDestination Acceptable values: - Path for new raster layer OUTPUT9: NumInFlowCells Argument type: rasterDestination Acceptable values: - Path for new raster layer pCr: Hauptgerinne-Parameter pHG Default value: 0.0035 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 nCr: Hauptgerinne-Speicherkaskade nHG 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 EnfVmax: Maximal Geschwindigkeit des Hauptgerinnes beruecksichtigen Default value: true Argument type: boolean Acceptable values: - 1 for true/yes - 0 for false/no - 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 VTresh: Maximalgeschwindigkeit im Hauptgerinne in km/h Default value: 4 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_riverbasin(
  INPUT = qgisprocess:::qgis_default_value(),
  INPUT2 = qgisprocess:::qgis_default_value(),
  INPUT3 = qgisprocess:::qgis_default_value(),
  WCons = qgisprocess:::qgis_default_value(),
  WCons2 = qgisprocess:::qgis_default_value(),
  OUTPUT2 = qgisprocess:::qgis_default_value(),
  OUTPUT3 = qgisprocess:::qgis_default_value(),
  OUTPUT4 = qgisprocess:::qgis_default_value(),
  OUTPUT5 = qgisprocess:::qgis_default_value(),
  OUTPUT6 = qgisprocess:::qgis_default_value(),
  OUTPUT7 = qgisprocess:::qgis_default_value(),
  OUTPUT8 = qgisprocess:::qgis_default_value(),
  OUTPUT9 = qgisprocess:::qgis_default_value(),
  pCr = qgisprocess:::qgis_default_value(),
  nCr = qgisprocess:::qgis_default_value(),
  EnfVmax = qgisprocess:::qgis_default_value(),
  VTresh = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT	raster - DTM. Path to a raster layer.
INPUT2	raster - HGGrid. Path to a raster layer.
INPUT3	raster - statisches Entnahmeraster. Path to a raster layer.
WCons	boolean - Anteilige Flaechenwasserentnahme. 1 for true/yes. 0 for false/no. 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.
WCons2	enum of ⁠("(0) ...anteilig aus den Flussrasterzellen", "(1) ...anteilig aus Rasterzellen der Teileinzugegebiete")⁠ - Dynamische Flaechenwassernutzung.... Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
OUTPUT2	rasterDestination - Grad. Path for new raster layer.
OUTPUT3	rasterDestination - Direc. Path for new raster layer.
OUTPUT4	rasterDestination - HGGrad. Path for new raster layer.
OUTPUT5	rasterDestination - RivSpeed. Path for new raster layer.
OUTPUT6	rasterDestination - Coordinates. Path for new raster layer.
OUTPUT7	rasterDestination - BasinShare. Path for new raster layer.
OUTPUT8	rasterDestination - statWUse. Path for new raster layer.
OUTPUT9	rasterDestination - NumInFlowCells. Path for new raster layer.
pCr	number - Hauptgerinne-Parameter pHG. 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.
nCr	number - Hauptgerinne-Speicherkaskade nHG. 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.
EnfVmax	boolean - Maximal Geschwindigkeit des Hauptgerinnes beruecksichtigen. 1 for true/yes. 0 for false/no. 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.
VTresh	number - Maximalgeschwindigkeit im Hauptgerinne in km/h. 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

• OUTPUT2 - outputRaster - Grad

• OUTPUT3 - outputRaster - Direc

• OUTPUT4 - outputRaster - HGGrad

• OUTPUT5 - outputRaster - RivSpeed

• OUTPUT6 - outputRaster - Coordinates

• OUTPUT7 - outputRaster - BasinShare

• OUTPUT8 - outputRaster - statWUse

• OUTPUT9 - outputRaster - NumInFlowCells

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