sagang_multibandvariation: QGIS algorithm - Multi-band variation

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

QGIS algorithm - Multi-band variation

Description

QGIS Algorithm provided by SAGA Next Gen Multi-band variation (sagang:multibandvariation). —————- Arguments —————- BANDS: Bands Argument type: multilayer MEAN: Mean Distance Argument type: rasterDestination Acceptable values: - Path for new raster layer STDDEV: Standard Deviation Argument type: rasterDestination Acceptable values: - Path for new raster layer DIFF: Distance Argument type: rasterDestination Acceptable values: - Path for new raster layer RADIUS: Radius (Cells) 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: 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

Usage

sagang_multibandvariation(
  BANDS = qgisprocess:::qgis_default_value(),
  MEAN = qgisprocess:::qgis_default_value(),
  STDDEV = qgisprocess:::qgis_default_value(),
  DIFF = 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()
)

Arguments

BANDS	multilayer - Bands. .
MEAN	rasterDestination - Mean Distance. Path for new raster layer.
STDDEV	rasterDestination - Standard Deviation. Path for new raster layer.
DIFF	rasterDestination - Distance. Path for new raster layer.
RADIUS	number - Radius (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.
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

• DIFF - outputRaster - Distance

• MEAN - outputRaster - Mean Distance

• STDDEV - outputRaster - Standard Deviation

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