qgis_rasterlayeruniquevaluesreport: QGIS algorithm - Raster layer unique values report

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

QGIS algorithm - Raster layer unique values report

Description

QGIS Algorithm provided by QGIS (native c++) Raster layer unique values report (native:rasterlayeruniquevaluesreport). This algorithm returns the count and area of each unique value in a given raster layer. The area calculation is done in the area unit of the layer's CRS.

Usage

qgis_rasterlayeruniquevaluesreport(
  INPUT = qgisprocess:::qgis_default_value(),
  BAND = qgisprocess:::qgis_default_value(),
  OUTPUT_HTML_FILE = qgisprocess:::qgis_default_value(),
  OUTPUT_TABLE = 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 - Unique values report. Path for new file.
OUTPUT_TABLE	sink - Unique values table. Path for new vector layer.
...	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

• CRS_AUTHID - outputString - CRS authority identifier

• EXTENT - outputString - Extent

• HEIGHT_IN_PIXELS - outputNumber - Height in pixels

• NODATA_PIXEL_COUNT - outputNumber - NoData pixel count

• OUTPUT_HTML_FILE - outputHtml - Unique values report

• OUTPUT_TABLE - outputVector - Unique values table

• TOTAL_PIXEL_COUNT - outputNumber - Total pixel count

• WIDTH_IN_PIXELS - outputNumber - Width in pixels

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