sagang_terrainsurfaceconvexity: QGIS algorithm - Terrain surface convexity

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

QGIS algorithm - Terrain surface convexity

Description

QGIS Algorithm provided by SAGA Next Gen Terrain surface convexity (sagang:terrainsurfaceconvexity). —————- Arguments —————- DEM: Elevation Argument type: raster Acceptable values: - Path to a raster layer CONVEXITY: Convexity Argument type: rasterDestination Acceptable values: - Path for new raster layer KERNEL: Laplacian Filter Kernel Default value: 0 Argument type: enum Available values: - 0: (0) conventional four-neighbourhood - 1: (1) conventional eight-neihbourhood - 2: (2) eight-neihbourhood (distance based weighting) Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' TYPE: Type Default value: 0 Argument type: enum Available values: - 0: (0) convexity - 1: (1) concavity Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' EPSILON: Flat Area Threshold 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 SCALE: Scale (Cells) 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 METHOD: Method Default value: 1 Argument type: enum Available values: - 0: (0) counting cells - 1: (1) resampling Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' DW_WEIGHTING: Weighting Function Default value: 3 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: 0.7 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_terrainsurfaceconvexity(
  DEM = qgisprocess:::qgis_default_value(),
  CONVEXITY = qgisprocess:::qgis_default_value(),
  KERNEL = qgisprocess:::qgis_default_value(),
  TYPE = qgisprocess:::qgis_default_value(),
  EPSILON = qgisprocess:::qgis_default_value(),
  SCALE = qgisprocess:::qgis_default_value(),
  METHOD = 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()
)

Arguments

DEM	raster - Elevation. Path to a raster layer.
CONVEXITY	rasterDestination - Convexity. Path for new raster layer.
KERNEL	enum of ⁠("(0) conventional four-neighbourhood", "(1) conventional eight-neihbourhood", "(2) eight-neihbourhood (distance based weighting)")⁠ - Laplacian Filter Kernel. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
TYPE	enum of ⁠("(0) convexity", "(1) concavity")⁠ - Type. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
EPSILON	number - Flat Area 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.
SCALE	number - Scale (Cells). 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	enum of ⁠("(0) counting cells", "(1) resampling")⁠ - Method. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
DW_WEIGHTING	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'.
DW_IDW_POWER	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.
DW_BANDWIDTH	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()
.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

• CONVEXITY - outputRaster - Convexity

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