QGIS algorithm - Multi direction lee filter

Source: R/sagang_multidirectionleefilter.R

QGIS Algorithm provided by SAGA Next Gen Multi direction lee filter (sagang:multidirectionleefilter). —————- Arguments —————- INPUT: Grid Argument type: raster Acceptable values: - Path to a raster layer RESULT: Filtered Grid Argument type: rasterDestination Acceptable values: - Path for new raster layer STDDEV: Minimum Standard Deviation Argument type: rasterDestination Acceptable values: - Path for new raster layer DIR: Direction of Minimum Standard Deviation Argument type: rasterDestination Acceptable values: - Path for new raster layer NOISE_ABS: Estimated Noise (absolute) 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 NOISE_REL: Estimated Noise (relative) 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 WEIGHTED: Weighted 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 METHOD: Method Default value: 1 Argument type: enum Available values: - 0: (0) noise variance given as absolute value - 1: (1) noise variance given relative to mean standard deviation - 2: (2) original calculation (Ringeler) Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3'

sagang_multidirectionleefilter(
  INPUT = qgisprocess:::qgis_default_value(),
  RESULT = qgisprocess:::qgis_default_value(),
  STDDEV = qgisprocess:::qgis_default_value(),
  DIR = qgisprocess:::qgis_default_value(),
  NOISE_ABS = qgisprocess:::qgis_default_value(),
  NOISE_REL = qgisprocess:::qgis_default_value(),
  WEIGHTED = qgisprocess:::qgis_default_value(),
  METHOD = 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 - Filtered Grid. Path for new raster layer.

STDDEV

rasterDestination - Minimum Standard Deviation. Path for new raster layer.

DIR

rasterDestination - Direction of Minimum Standard Deviation. Path for new raster layer.

NOISE_ABS

number - Estimated Noise (absolute). 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.

NOISE_REL

number - Estimated Noise (relative). 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.

WEIGHTED

boolean - Weighted. 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.

METHOD

enum of ("(0) noise variance given as absolute value", "(1) noise variance given relative to mean standard deviation", "(2) original calculation (Ringeler)") - Method. 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

  • DIR - outputRaster - Direction of Minimum Standard Deviation

  • RESULT - outputRaster - Filtered Grid

  • STDDEV - outputRaster - Minimum Standard Deviation