qgis_rasterlayerstatistics: QGIS algorithm - Raster layer statistics

View source: R/qgis_rasterlayerstatistics.R

qgis_rasterlayerstatisticsR Documentation

QGIS algorithm - Raster layer statistics

Description

QGIS Algorithm provided by QGIS (native c++) Raster layer statistics (native:rasterlayerstatistics). This algorithm computes basic statistics from the values in a given band of the raster layer.

Usage

qgis_rasterlayerstatistics(
  INPUT = qgisprocess:::qgis_default_value(),
  BAND = qgisprocess:::qgis_default_value(),
  OUTPUT_HTML_FILE = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT

raster - Input layer. Path to a raster layer.

BAND

band - Band number. Integer value representing an existing raster band number.

OUTPUT_HTML_FILE

fileDestination - Statistics. Path for new file.

...

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

  • COUNT - outputNumber - Count of non-NoData pixels

  • MAX - outputNumber - Maximum value

  • MEAN - outputNumber - Mean value

  • MIN - outputNumber - Minimum value

  • OUTPUT_HTML_FILE - outputHtml - Statistics

  • RANGE - outputNumber - Range

  • STD_DEV - outputNumber - Standard deviation

  • SUM - outputNumber - Sum

  • SUM_OF_SQUARES - outputNumber - Sum of the squares


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