sagang_radiusofvarianceraster: QGIS algorithm - Radius of variance (raster)

View source: R/sagang_radiusofvarianceraster.R

sagang_radiusofvariancerasterR Documentation

QGIS algorithm - Radius of variance (raster)

Description

QGIS Algorithm provided by SAGA Next Gen Radius of variance (raster) (sagang:radiusofvarianceraster). —————- Arguments —————- INPUT: Grid Argument type: raster Acceptable values: - Path to a raster layer RESULT: Radius Argument type: rasterDestination Acceptable values: - Path for new raster layer STDDEV: Standard Deviation 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 RADIUS: Maximum Search Radius (cells) Default value: 20 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 OUTPUT: Type of Output Default value: 0 Argument type: enum Available values: - 0: (0) Cells - 1: (1) Map Units Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3'

Usage

sagang_radiusofvarianceraster(
  INPUT = qgisprocess:::qgis_default_value(),
  RESULT = qgisprocess:::qgis_default_value(),
  STDDEV = qgisprocess:::qgis_default_value(),
  RADIUS = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT

raster - Grid. Path to a raster layer.

RESULT

rasterDestination - Radius. Path for new raster layer.

STDDEV

number - Standard Deviation. 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.

RADIUS

number - Maximum Search 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.

OUTPUT

enum of ⁠("(0) Cells", "(1) Map Units")⁠ - Type of Output. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

...

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

  • RESULT - outputRaster - Radius


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