R/qgis_rasterlayerproperties.R

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

##' 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.
##'
##' @title QGIS algorithm - Raster layer properties
##'
##' @param INPUT `raster` - Input layer. Path to a raster layer.
##' @param BAND `band` - Band number. Integer value representing an existing raster band number.
##' @param ... further parameters passed to `qgisprocess::qgis_run_algorithm()`
##' @param .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`.
##' @param .quiet logical specifying if parameter `.quiet` for `qgisprocess::qgis_run_algorithm()` Default value is `TRUE`.
##' @param .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
##'
##'
##' @export
##' @md
##' @importFrom qgisprocess qgis_run_algorithm

qgis_rasterlayerproperties <- function(INPUT = qgisprocess:::qgis_default_value(), BAND = qgisprocess:::qgis_default_value(),..., .complete_output = .complete_output_option(), .quiet = .quiet_option(), .messages = .message_option()) {

  check_algorithm_necessities("native:rasterlayerproperties")

  if (.messages){
    output <- qgisprocess::qgis_run_algorithm("native:rasterlayerproperties", `INPUT` = INPUT, `BAND` = BAND,..., .quiet = .quiet)
  } else {
    suppressMessages(
      output <- qgisprocess::qgis_run_algorithm("native:rasterlayerproperties", `INPUT` = INPUT, `BAND` = BAND,..., .quiet = .quiet)
      )
  }

  if (.complete_output) {
    return(output)
  }
  else{
    qgisprocess::qgis_extract_output(output, "BAND_COUNT")
  }
}