R/sagang_topographicopenness.R
sagang_topographicopenness.Rd
QGIS Algorithm provided by SAGA Next Gen Topographic openness (sagang:topographicopenness). —————- Arguments —————- DEM: Elevation Argument type: raster Acceptable values: - Path to a raster layer POS: Positive Openness Argument type: rasterDestination Acceptable values: - Path for new raster layer NEG: Negative Openness Argument type: rasterDestination Acceptable values: - Path for new raster layer RADIUS: Radial Limit Default value: 10000 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 METHOD: Method Default value: 1 Argument type: enum Available values: - 0: (0) multi scale - 1: (1) line tracing Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' DLEVEL: Multi Scale Factor Default value: 3 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 NDIRS: Number of Sectors Default value: 8 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 UNIT: Unit Default value: 0 Argument type: enum Available values: - 0: (0) Radians - 1: (1) Degree Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' NADIR: Difference from Nadir 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
sagang_topographicopenness(
DEM = qgisprocess:::qgis_default_value(),
POS = qgisprocess:::qgis_default_value(),
NEG = qgisprocess:::qgis_default_value(),
RADIUS = qgisprocess:::qgis_default_value(),
METHOD = qgisprocess:::qgis_default_value(),
DLEVEL = qgisprocess:::qgis_default_value(),
NDIRS = qgisprocess:::qgis_default_value(),
UNIT = qgisprocess:::qgis_default_value(),
NADIR = qgisprocess:::qgis_default_value(),
...,
.complete_output = .complete_output_option(),
.quiet = .quiet_option(),
.messages = .message_option()
)
raster
- Elevation. Path to a raster layer.
rasterDestination
- Positive Openness. Path for new raster layer.
rasterDestination
- Negative Openness. Path for new raster layer.
number
- Radial Limit. 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) multi scale", "(1) line tracing")
- Method. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
number
- Multi Scale Factor. 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
- Number of Sectors. 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) Radians", "(1) Degree")
- Unit. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
boolean
- Difference from Nadir. 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()
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
.