sagang_averagewiththereshold3: QGIS algorithm - Average with thereshold 3

View source: R/sagang_averagewiththereshold3.R

sagang_averagewiththereshold3R Documentation

QGIS algorithm - Average with thereshold 3

Description

QGIS Algorithm provided by SAGA Next Gen Average with thereshold 3 (sagang:averagewiththereshold3). —————- Arguments —————- INPUT: Input Argument type: raster Acceptable values: - Path to a raster layer RESULT: AWT Grid Argument type: rasterDestination Acceptable values: - Path for new raster layer RX: Radius X 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 RY: Radius Y 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 THRESH: Threshold 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

Usage

sagang_averagewiththereshold3(
  INPUT = qgisprocess:::qgis_default_value(),
  RESULT = qgisprocess:::qgis_default_value(),
  RX = qgisprocess:::qgis_default_value(),
  RY = qgisprocess:::qgis_default_value(),
  THRESH = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT

raster - Input. Path to a raster layer.

RESULT

rasterDestination - AWT Grid. Path for new raster layer.

RX

number - Radius X. 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.

RY

number - Radius Y. 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.

THRESH

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

...

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 - AWT Grid


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