sagang_valleydepth: QGIS algorithm - Valley depth

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

QGIS algorithm - Valley depth

Description

QGIS Algorithm provided by SAGA Next Gen Valley depth (sagang:valleydepth). —————- Arguments —————- ELEVATION: Elevation Argument type: raster Acceptable values: - Path to a raster layer VALLEY_DEPTH: Valley Depth Argument type: rasterDestination Acceptable values: - Path for new raster layer RIDGE_LEVEL: Ridge Level Argument type: rasterDestination Acceptable values: - Path for new raster layer THRESHOLD: Tension Threshold 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 MAXITER: Maximum Iterations 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 NOUNDERGROUND: Keep Ridge Level above Surface 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 ORDER: Ridge Detection Threshold 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_valleydepth(
  ELEVATION = qgisprocess:::qgis_default_value(),
  VALLEY_DEPTH = qgisprocess:::qgis_default_value(),
  RIDGE_LEVEL = qgisprocess:::qgis_default_value(),
  THRESHOLD = qgisprocess:::qgis_default_value(),
  MAXITER = qgisprocess:::qgis_default_value(),
  NOUNDERGROUND = qgisprocess:::qgis_default_value(),
  ORDER = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

ELEVATION	raster - Elevation. Path to a raster layer.
VALLEY_DEPTH	rasterDestination - Valley Depth. Path for new raster layer.
RIDGE_LEVEL	rasterDestination - Ridge Level. Path for new raster layer.
THRESHOLD	number - Tension Threshold. 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.
MAXITER	number - Maximum Iterations. 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.
NOUNDERGROUND	boolean - Keep Ridge Level above Surface. 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.
ORDER	number - Ridge Detection Threshold. 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

• RIDGE_LEVEL - outputRaster - Ridge Level

• VALLEY_DEPTH - outputRaster - Valley Depth

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