qgis_zonalstatistics: QGIS algorithm - Zonal statistics (in place)

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

QGIS algorithm - Zonal statistics (in place)

Description

QGIS Algorithm provided by QGIS (native c++) Zonal statistics (in place) (native:zonalstatistics). Calculates statistics for a raster layer's values for each feature of an overlapping polygon vector layer. This algorithm calculates statistics of a raster layer for each feature of an overlapping polygon vector layer. The results will be written in place.

Usage

qgis_zonalstatistics(
  INPUT_RASTER = qgisprocess:::qgis_default_value(),
  RASTER_BAND = qgisprocess:::qgis_default_value(),
  INPUT_VECTOR = qgisprocess:::qgis_default_value(),
  COLUMN_PREFIX = qgisprocess:::qgis_default_value(),
  STATISTICS = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT_RASTER	raster - Raster layer. Path to a raster layer.
RASTER_BAND	band - Raster band. Integer value representing an existing raster band number.
INPUT_VECTOR	vector - Vector layer containing zones. Path to a vector layer.
COLUMN_PREFIX	string - Output column prefix. String 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.
STATISTICS	enum of ⁠("Count", "Sum", "Mean", "Median", "St dev", "Minimum", "Maximum", "Range", "Minority", "Majority", "Variety", "Variance")⁠ - Statistics to calculate. 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

• INPUT_VECTOR - outputVector - Zonal statistics

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