sagang_focalstatistics: QGIS algorithm - Focal statistics

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

QGIS algorithm - Focal statistics

Description

QGIS Algorithm provided by SAGA Next Gen Focal statistics (sagang:focalstatistics). —————- Arguments —————- GRID: Grid Argument type: raster Acceptable values: - Path to a raster layer MEAN: Mean Value Argument type: rasterDestination Acceptable values: - Path for new raster layer MIN: Minimum Value Argument type: rasterDestination Acceptable values: - Path for new raster layer MAX: Maximum Value Argument type: rasterDestination Acceptable values: - Path for new raster layer RANGE: Value Range Argument type: rasterDestination Acceptable values: - Path for new raster layer STDDEV: Standard Deviation Argument type: rasterDestination Acceptable values: - Path for new raster layer VARIANCE: Variance Argument type: rasterDestination Acceptable values: - Path for new raster layer SUM: Sum Argument type: rasterDestination Acceptable values: - Path for new raster layer DIFF: Difference from Mean Value Argument type: rasterDestination Acceptable values: - Path for new raster layer DEVMEAN: Deviation from Mean Value Argument type: rasterDestination Acceptable values: - Path for new raster layer PERCENT: Percentile Argument type: rasterDestination Acceptable values: - Path for new raster layer MEDIAN: Median Argument type: rasterDestination Acceptable values: - Path for new raster layer MINORITY: Minority Argument type: rasterDestination Acceptable values: - Path for new raster layer MAJORITY: Majority Argument type: rasterDestination Acceptable values: - Path for new raster layer BCENTER: Include Center Cell 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 KERNEL_TYPE: Kernel Type Default value: 1 Argument type: enum Available values: - 0: (0) Square - 1: (1) Circle - 2: (2) Annulus - 3: (3) Sector Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' KERNEL_INNER: Inner Radius 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 KERNEL_RADIUS: Radius 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 KERNEL_DIRECTION: Direction 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 KERNEL_TOLERANCE: Tolerance Default value: 5 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 DW_WEIGHTING: Weighting Function Default value: 0 Argument type: enum Available values: - 0: (0) no distance weighting - 1: (1) inverse distance to a power - 2: (2) exponential - 3: (3) gaussian Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' DW_IDW_POWER: Power 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 DW_BANDWIDTH: Bandwidth 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_focalstatistics(
  GRID = qgisprocess:::qgis_default_value(),
  MEAN = qgisprocess:::qgis_default_value(),
  MIN = qgisprocess:::qgis_default_value(),
  MAX = qgisprocess:::qgis_default_value(),
  RANGE = qgisprocess:::qgis_default_value(),
  STDDEV = qgisprocess:::qgis_default_value(),
  VARIANCE = qgisprocess:::qgis_default_value(),
  SUM = qgisprocess:::qgis_default_value(),
  DIFF = qgisprocess:::qgis_default_value(),
  DEVMEAN = qgisprocess:::qgis_default_value(),
  PERCENT = qgisprocess:::qgis_default_value(),
  MEDIAN = qgisprocess:::qgis_default_value(),
  MINORITY = qgisprocess:::qgis_default_value(),
  MAJORITY = qgisprocess:::qgis_default_value(),
  BCENTER = qgisprocess:::qgis_default_value(),
  KERNEL_TYPE = qgisprocess:::qgis_default_value(),
  KERNEL_INNER = qgisprocess:::qgis_default_value(),
  KERNEL_RADIUS = qgisprocess:::qgis_default_value(),
  KERNEL_DIRECTION = qgisprocess:::qgis_default_value(),
  KERNEL_TOLERANCE = qgisprocess:::qgis_default_value(),
  DW_WEIGHTING = qgisprocess:::qgis_default_value(),
  DW_IDW_POWER = qgisprocess:::qgis_default_value(),
  DW_BANDWIDTH = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

GRID	raster - Grid. Path to a raster layer.
MEAN	rasterDestination - Mean Value. Path for new raster layer.
MIN	rasterDestination - Minimum Value. Path for new raster layer.
MAX	rasterDestination - Maximum Value. Path for new raster layer.
RANGE	rasterDestination - Value Range. Path for new raster layer.
STDDEV	rasterDestination - Standard Deviation. Path for new raster layer.
VARIANCE	rasterDestination - Variance. Path for new raster layer.
SUM	rasterDestination - Sum. Path for new raster layer.
DIFF	rasterDestination - Difference from Mean Value. Path for new raster layer.
DEVMEAN	rasterDestination - Deviation from Mean Value. Path for new raster layer.
PERCENT	rasterDestination - Percentile. Path for new raster layer.
MEDIAN	rasterDestination - Median. Path for new raster layer.
MINORITY	rasterDestination - Minority. Path for new raster layer.
MAJORITY	rasterDestination - Majority. Path for new raster layer.
BCENTER	boolean - Include Center Cell. 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.
KERNEL_TYPE	enum of ⁠("(0) Square", "(1) Circle", "(2) Annulus", "(3) Sector")⁠ - Kernel Type. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
KERNEL_INNER	number - Inner 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.
KERNEL_RADIUS	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.
KERNEL_DIRECTION	number - Direction. 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.
KERNEL_TOLERANCE	number - Tolerance. 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.
DW_WEIGHTING	enum of ⁠("(0) no distance weighting", "(1) inverse distance to a power", "(2) exponential", "(3) gaussian")⁠ - Weighting Function. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
DW_IDW_POWER	number - Power. 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.
DW_BANDWIDTH	number - Bandwidth. 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

• DEVMEAN - outputRaster - Deviation from Mean Value

• DIFF - outputRaster - Difference from Mean Value

• MAJORITY - outputRaster - Majority

• MAX - outputRaster - Maximum Value

• MEAN - outputRaster - Mean Value

• MEDIAN - outputRaster - Median

• MIN - outputRaster - Minimum Value

• MINORITY - outputRaster - Minority

• PERCENT - outputRaster - Percentile

• RANGE - outputRaster - Value Range

• STDDEV - outputRaster - Standard Deviation

• SUM - outputRaster - Sum

• VARIANCE - outputRaster - Variance

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