sagang_diffusivehillslopeevolutionftcs: QGIS algorithm - Diffusive hillslope evolution (ftcs)

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

QGIS algorithm - Diffusive hillslope evolution (ftcs)

Description

QGIS Algorithm provided by SAGA Next Gen Diffusive hillslope evolution (ftcs) (sagang:diffusivehillslopeevolutionftcs). —————- Arguments —————- DEM: Elevation Argument type: raster Acceptable values: - Path to a raster layer MODEL: Modelled Elevation Argument type: rasterDestination Acceptable values: - Path for new raster layer DIFF: Elevation Difference Argument type: rasterDestination Acceptable values: - Path for new raster layer UPDATE: Update 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 KAPPA: Diffusivity (m2 / kyr) 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 DURATION: Simulation Time (kyr) Default value: 100 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 TIMESTEP: Time Step Default value: 1 Argument type: enum Available values: - 0: (0) user defined - 1: (1) automatically Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' DTIME: Time Step (kyr) Default value: 10 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 NEIGHBOURS: Neighbourhood Default value: 1 Argument type: enum Available values: - 0: (0) Neumann - 1: (1) Moore Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3'

Usage

sagang_diffusivehillslopeevolutionftcs(
  DEM = qgisprocess:::qgis_default_value(),
  MODEL = qgisprocess:::qgis_default_value(),
  DIFF = qgisprocess:::qgis_default_value(),
  UPDATE = qgisprocess:::qgis_default_value(),
  KAPPA = qgisprocess:::qgis_default_value(),
  DURATION = qgisprocess:::qgis_default_value(),
  TIMESTEP = qgisprocess:::qgis_default_value(),
  DTIME = qgisprocess:::qgis_default_value(),
  NEIGHBOURS = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

DEM	raster - Elevation. Path to a raster layer.
MODEL	rasterDestination - Modelled Elevation. Path for new raster layer.
DIFF	rasterDestination - Elevation Difference. Path for new raster layer.
UPDATE	boolean - Update. 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.
KAPPA	number - Diffusivity (m2 / kyr). 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.
DURATION	number - Simulation Time (kyr). 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.
TIMESTEP	enum of ⁠("(0) user defined", "(1) automatically")⁠ - Time Step. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
DTIME	number - Time Step (kyr). 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.
NEIGHBOURS	enum of ⁠("(0) Neumann", "(1) Moore")⁠ - Neighbourhood. 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

• DIFF - outputRaster - Elevation Difference

• MODEL - outputRaster - Modelled Elevation

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