QGIS algorithm - Destriping with mask

Source: R/sagang_destripingwithmask.R

QGIS Algorithm provided by SAGA Next Gen Destriping with mask (sagang:destripingwithmask). —————- Arguments —————- INPUT: Grid Argument type: raster Acceptable values: - Path to a raster layer MASK: Mask Argument type: raster Acceptable values: - Path to a raster layer RESULT3: Destriped Grid Argument type: rasterDestination Acceptable values: - Path for new raster layer RESULT1: Low-pass 1 Argument type: rasterDestination Acceptable values: - Path for new raster layer RESULT2: Low-pass 2 Argument type: rasterDestination Acceptable values: - Path for new raster layer STRIPES: Stripes Argument type: rasterDestination Acceptable values: - Path for new raster layer ANG: Angle 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 R: Radius 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 D: Stripes Distance 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 MIN: Minimum 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 MAX: Maximum 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 MMIN: Mask Minimum Default value: -10000 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 MMAX: Mask Maximum Default value: 10000 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

sagang_destripingwithmask(
  INPUT = qgisprocess:::qgis_default_value(),
  MASK = qgisprocess:::qgis_default_value(),
  RESULT3 = qgisprocess:::qgis_default_value(),
  RESULT1 = qgisprocess:::qgis_default_value(),
  RESULT2 = qgisprocess:::qgis_default_value(),
  STRIPES = qgisprocess:::qgis_default_value(),
  ANG = qgisprocess:::qgis_default_value(),
  R = qgisprocess:::qgis_default_value(),
  D = qgisprocess:::qgis_default_value(),
  MIN = qgisprocess:::qgis_default_value(),
  MAX = qgisprocess:::qgis_default_value(),
  MMIN = qgisprocess:::qgis_default_value(),
  MMAX = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT

raster - Grid. Path to a raster layer.

MASK

raster - Mask. Path to a raster layer.

RESULT3

rasterDestination - Destriped Grid. Path for new raster layer.

RESULT1

rasterDestination - Low-pass 1. Path for new raster layer.

RESULT2

rasterDestination - Low-pass 2. Path for new raster layer.

STRIPES

rasterDestination - Stripes. Path for new raster layer.

ANG

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

R

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

D

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

MIN

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

MAX

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

MMIN

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

MMAX

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

  • RESULT1 - outputRaster - Low-pass 1

  • RESULT2 - outputRaster - Low-pass 2

  • RESULT3 - outputRaster - Destriped Grid

  • STRIPES - outputRaster - Stripes