qgis_rasterlayerproperties: QGIS algorithm - Raster layer properties

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

QGIS algorithm - Raster layer properties

Description

QGIS Algorithm provided by QGIS (native c++) Raster layer properties (native:rasterlayerproperties). This algorithm returns basic properties of the given raster layer, including the extent, size in pixels and dimensions of pixels (in map units). If an optional band number is specified then the NoData value for the selected band will also be returned.

Usage

qgis_rasterlayerproperties(
  INPUT = qgisprocess:::qgis_default_value(),
  BAND = 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.
...	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

• BAND_COUNT - outputNumber - Number of bands in raster

• CRS_AUTHID - outputString - CRS authority identifier

• EXTENT - outputString - Extent

• HAS_NODATA_VALUE - outputBoolean - Band has a NoData value set

• HEIGHT_IN_PIXELS - outputNumber - Height in pixels

• NODATA_VALUE - outputNumber - Band NoData value

• PIXEL_HEIGHT - outputNumber - Pixel size (height) in map units

• PIXEL_WIDTH - outputNumber - Pixel size (width) in map units

• WIDTH_IN_PIXELS - outputNumber - Width in pixels

• X_MAX - outputNumber - Maximum x-coordinate

• X_MIN - outputNumber - Minimum x-coordinate

• Y_MAX - outputNumber - Maximum y-coordinate

• Y_MIN - outputNumber - Minimum y-coordinate

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