sagang_averagewithmask2: QGIS algorithm - Average with mask 2

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

QGIS algorithm - Average with mask 2

Description

QGIS Algorithm provided by SAGA Next Gen Average with mask 2 (sagang:averagewithmask2). —————- Arguments —————- INPUT: Input Argument type: raster Acceptable values: - Path to a raster layer MASK: Mask Grid Argument type: raster Acceptable values: - Path to a raster layer RESULT: AWM2 Grid Argument type: rasterDestination Acceptable values: - Path for new raster layer V: Mask value 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 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

Usage

sagang_averagewithmask2(
  INPUT = qgisprocess:::qgis_default_value(),
  MASK = qgisprocess:::qgis_default_value(),
  RESULT = qgisprocess:::qgis_default_value(),
  V = qgisprocess:::qgis_default_value(),
  RX = qgisprocess:::qgis_default_value(),
  RY = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT	raster - Input. Path to a raster layer.
MASK	raster - Mask Grid. Path to a raster layer.
RESULT	rasterDestination - AWM2 Grid. Path for new raster layer.
V	number - Mask value. 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.
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.
...	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 - AWM2 Grid

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