sagang_tobia: QGIS algorithm - Tobia

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

QGIS algorithm - Tobia

Description

QGIS Algorithm provided by SAGA Next Gen Tobia (sagang:tobia). —————- Arguments —————- A: Slope grid (rad) Argument type: raster Acceptable values: - Path to a raster layer B: Aspect grid (rad) Argument type: raster Acceptable values: - Path to a raster layer C: Dip grid (degrees) (optional) Argument type: raster Acceptable values: - Path to a raster layer D: Dip direction grid (degrees) (optional) Argument type: raster Acceptable values: - Path to a raster layer fB: Global structure dip (degrees) Default value: 45 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 fC: Global structure dip direction (degrees) Default value: 90 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 E: TOBIA classes Argument type: rasterDestination Acceptable values: - Path for new raster layer F: TOBIA index Argument type: rasterDestination Acceptable values: - Path for new raster layer

Usage

sagang_tobia(
  A = qgisprocess:::qgis_default_value(),
  B = qgisprocess:::qgis_default_value(),
  C = qgisprocess:::qgis_default_value(),
  D = qgisprocess:::qgis_default_value(),
  fB = qgisprocess:::qgis_default_value(),
  fC = qgisprocess:::qgis_default_value(),
  E = qgisprocess:::qgis_default_value(),
  F = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

A	raster - Slope grid (rad). Path to a raster layer.
B	raster - Aspect grid (rad). Path to a raster layer.
C	raster - Dip grid (degrees) . Path to a raster layer.
D	raster - Dip direction grid (degrees) . Path to a raster layer.
fB	number - Global structure dip (degrees). 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.
fC	number - Global structure dip direction (degrees). 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.
E	rasterDestination - TOBIA classes. Path for new raster layer.
F	rasterDestination - TOBIA index. Path for new raster layer.
...	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

• E - outputRaster - TOBIA classes

• F - outputRaster - TOBIA index

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