sagang_topmodel: QGIS algorithm - Topmodel

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

QGIS algorithm - Topmodel

Description

QGIS Algorithm provided by SAGA Next Gen Topmodel (sagang:topmodel). —————- Arguments —————- ATANB: Topographic Wetness Index Argument type: raster Acceptable values: - Path to a raster layer MOIST: Soil Moisture Deficit Argument type: rasterDestination Acceptable values: - Path for new raster layer WEATHER: Weather Records Argument type: source Acceptable values: - Path to a vector layer RECORD_P: Precipitation (m / dt) Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names RECORD_ET: Evapotranspiration (m / dt) Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names RECORD_DATE: Date/Time Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names TABLE: Simulation Output Argument type: vectorDestination Acceptable values: - Path for new vector layer DTIME: Time Step (h) 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 NCLASSES: Number of Classes Default value: 30 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 P_QS0: Initial subsurface flow per unit area (m/h) Default value: 3.3e-05 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 P_LNTE: Areal average of ln(T0) = ln(Te) (ln(m^2/h)) Default value: 5 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 P_MODEL: Model parameter (m) Default value: 0.032 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 P_SR0: Initial root zone storage deficit (m) Default value: 0.002 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 P_SRZMAX: Maximum root zone storage deficit (m) Default value: 0.05 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 P_SUZ_TD: Unsaturated zone time delay per unit storage deficit (h) Default value: 50 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 P_VCH: Main channel routing velocity (m/h) Default value: 3600 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 P_VR: Internal subcatchment routing velocity (m/h) Default value: 3600 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 P_K0: Surface hydraulic conductivity (m/h) 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 P_PSI: Wetting front suction (m) Default value: 0.02 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 P_DTHETA: Water content change across the wetting front Default value: 0.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 BINF: Green-Ampt Infiltration 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

Usage

sagang_topmodel(
  ATANB = qgisprocess:::qgis_default_value(),
  MOIST = qgisprocess:::qgis_default_value(),
  WEATHER = qgisprocess:::qgis_default_value(),
  RECORD_P = qgisprocess:::qgis_default_value(),
  RECORD_ET = qgisprocess:::qgis_default_value(),
  RECORD_DATE = qgisprocess:::qgis_default_value(),
  TABLE = qgisprocess:::qgis_default_value(),
  DTIME = qgisprocess:::qgis_default_value(),
  NCLASSES = qgisprocess:::qgis_default_value(),
  P_QS0 = qgisprocess:::qgis_default_value(),
  P_LNTE = qgisprocess:::qgis_default_value(),
  P_MODEL = qgisprocess:::qgis_default_value(),
  P_SR0 = qgisprocess:::qgis_default_value(),
  P_SRZMAX = qgisprocess:::qgis_default_value(),
  P_SUZ_TD = qgisprocess:::qgis_default_value(),
  P_VCH = qgisprocess:::qgis_default_value(),
  P_VR = qgisprocess:::qgis_default_value(),
  P_K0 = qgisprocess:::qgis_default_value(),
  P_PSI = qgisprocess:::qgis_default_value(),
  P_DTHETA = qgisprocess:::qgis_default_value(),
  BINF = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

ATANB	raster - Topographic Wetness Index. Path to a raster layer.
MOIST	rasterDestination - Soil Moisture Deficit. Path for new raster layer.
WEATHER	source - Weather Records. Path to a vector layer.
RECORD_P	field - Precipitation (m / dt). The name of an existing field. ; delimited list of existing field names.
RECORD_ET	field - Evapotranspiration (m / dt). The name of an existing field. ; delimited list of existing field names.
RECORD_DATE	field - Date/Time. The name of an existing field. ; delimited list of existing field names.
TABLE	vectorDestination - Simulation Output. Path for new vector layer.
DTIME	number - Time Step (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.
NCLASSES	number - Number of Classes. 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.
P_QS0	number - Initial subsurface flow per unit area (m/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.
P_LNTE	number - Areal average of ln(T0) = ln(Te) (ln(m^2/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.
P_MODEL	number - Model parameter (m). 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.
P_SR0	number - Initial root zone storage deficit (m). 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.
P_SRZMAX	number - Maximum root zone storage deficit (m). 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.
P_SUZ_TD	number - Unsaturated zone time delay per unit storage deficit (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.
P_VCH	number - Main channel routing velocity (m/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.
P_VR	number - Internal subcatchment routing velocity (m/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.
P_K0	number - Surface hydraulic conductivity (m/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.
P_PSI	number - Wetting front suction (m). 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.
P_DTHETA	number - Water content change across the wetting front. 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.
BINF	boolean - Green-Ampt Infiltration. 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.
...	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

• MOIST - outputRaster - Soil Moisture Deficit

• TABLE - outputVector - Simulation Output

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