R/sagang_terrainruggednessindextri.R
sagang_terrainruggednessindextri.Rd
QGIS Algorithm provided by SAGA Next Gen Terrain ruggedness index (tri) (sagang:terrainruggednessindextri). —————- Arguments —————- DEM: Elevation Argument type: raster Acceptable values: - Path to a raster layer TRI: Terrain Ruggedness Index (TRI) Argument type: rasterDestination Acceptable values: - Path for new raster layer MODE: Search Mode Default value: 1 Argument type: enum Available values: - 0: (0) Square - 1: (1) Circle Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' RADIUS: Search Radius 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 DW_WEIGHTING: Weighting Function Default value: 0 Argument type: enum Available values: - 0: (0) no distance weighting - 1: (1) inverse distance to a power - 2: (2) exponential - 3: (3) gaussian Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' DW_IDW_POWER: Power Default value: 2 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 DW_BANDWIDTH: Bandwidth Default value: 75 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
sagang_terrainruggednessindextri(
DEM = qgisprocess:::qgis_default_value(),
TRI = qgisprocess:::qgis_default_value(),
MODE = qgisprocess:::qgis_default_value(),
RADIUS = qgisprocess:::qgis_default_value(),
DW_WEIGHTING = qgisprocess:::qgis_default_value(),
DW_IDW_POWER = qgisprocess:::qgis_default_value(),
DW_BANDWIDTH = qgisprocess:::qgis_default_value(),
...,
.complete_output = .complete_output_option(),
.quiet = .quiet_option(),
.messages = .message_option()
)
raster
- Elevation. Path to a raster layer.
rasterDestination
- Terrain Ruggedness Index (TRI). Path for new raster layer.
enum
of ("(0) Square", "(1) Circle")
- Search Mode. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
number
- Search Radius. 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.
enum
of ("(0) no distance weighting", "(1) inverse distance to a power", "(2) exponential", "(3) gaussian")
- Weighting Function. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
number
- Power. 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.
number
- Bandwidth. 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()
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
.
logical specifying if parameter .quiet
for qgisprocess::qgis_run_algorithm()
Default value is TRUE
.
logical specifying if messages from qgisprocess::qgis_run_algorithm()
should be printed (TRUE
) or not (FALSE
). Default value is FALSE
.