R/sagang_topographiccorrection.R

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

##' QGIS Algorithm provided by SAGA Next Gen Topographic correction (sagang:topographiccorrection). ---------------- Arguments ----------------  DEM: Elevation 	Argument type:	raster 	Acceptable values: 		- Path to a raster layer ORIGINAL: Original Image 	Argument type:	raster 	Acceptable values: 		- Path to a raster layer CORRECTED: Corrected Image 	Argument type:	rasterDestination 	Acceptable values: 		- Path for new raster layer AZI: Azimuth 	Default value:	180 	Argument type:	number 	Acceptable values: 		- A numeric 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 HGT: Height 	Default value:	45 	Argument type:	number 	Acceptable values: 		- A numeric 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 METHOD: Method 	Default value:	4 	Argument type:	enum 	Available values: 		- 0: (0) Cosine Correction (Teillet et al. 1982) 		- 1: (1) Cosine Correction (Civco 1989) 		- 2: (2) Minnaert Correction 		- 3: (3) Minnaert Correction with Slope (Riano et al. 2003) 		- 4: (4) Minnaert Correction with Slope (Law & Nichol 2004) 		- 5: (5) C Correction 		- 6: (6) Normalization (after Civco, modified by Law & Nichol) 	Acceptable values: 		- Number of selected option, e.g. '1' 		- Comma separated list of options, e.g. '1,3' MINNAERT: Minnaert Correction 	Default value:	0.5 	Argument type:	number 	Acceptable values: 		- A numeric 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 MAXCELLS: Maximum Cells (C Correction Analysis) 	Default value:	1000 	Argument type:	number 	Acceptable values: 		- A numeric 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 MAXVALUE: Value Range 	Default value:	0 	Argument type:	enum 	Available values: 		- 0: (0) 1 byte (0-255) 		- 1: (1) 2 byte (0-65535) 	Acceptable values: 		- Number of selected option, e.g. '1' 		- Comma separated list of options, e.g. '1,3'
##'
##' @title QGIS algorithm - Topographic correction
##'
##' @param DEM `raster` - Elevation. Path to a raster layer.
##' @param ORIGINAL `raster` - Original Image. Path to a raster layer.
##' @param CORRECTED `rasterDestination` - Corrected Image. Path for new raster layer.
##' @param AZI `number` - Azimuth. A numeric 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.
##' @param HGT `number` - Height. A numeric 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.
##' @param METHOD `enum`  of `("(0) Cosine Correction (Teillet et al. 1982)", "(1) Cosine Correction (Civco 1989)", "(2) Minnaert Correction", "(3) Minnaert Correction with Slope (Riano et al. 2003)", "(4) Minnaert Correction with Slope (Law & Nichol 2004)", "(5) C Correction", "(6) Normalization (after Civco, modified by Law & Nichol)")` - Method. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
##' @param MINNAERT `number` - Minnaert Correction. A numeric 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.
##' @param MAXCELLS `number` - Maximum Cells (C Correction Analysis). A numeric 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.
##' @param MAXVALUE `enum`  of `("(0) 1 byte (0-255)", "(1) 2 byte (0-65535)")` - Value Range. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
##' @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
##' * CORRECTED - outputRaster - Corrected Image
##'
##'
##' @export
##' @md
##' @importFrom qgisprocess qgis_run_algorithm

sagang_topographiccorrection <- function(DEM = qgisprocess:::qgis_default_value(), ORIGINAL = qgisprocess:::qgis_default_value(), CORRECTED = qgisprocess:::qgis_default_value(), AZI = qgisprocess:::qgis_default_value(), HGT = qgisprocess:::qgis_default_value(), METHOD = qgisprocess:::qgis_default_value(), MINNAERT = qgisprocess:::qgis_default_value(), MAXCELLS = qgisprocess:::qgis_default_value(), MAXVALUE = qgisprocess:::qgis_default_value(),..., .complete_output = .complete_output_option(), .quiet = .quiet_option(), .messages = .message_option()) {

  check_algorithm_necessities("sagang:topographiccorrection")

  if (.messages){
    output <- qgisprocess::qgis_run_algorithm("sagang:topographiccorrection", `DEM` = DEM, `ORIGINAL` = ORIGINAL, `CORRECTED` = CORRECTED, `AZI` = AZI, `HGT` = HGT, `METHOD` = METHOD, `MINNAERT` = MINNAERT, `MAXCELLS` = MAXCELLS, `MAXVALUE` = MAXVALUE,..., .quiet = .quiet)
  } else {
    suppressMessages(
      output <- qgisprocess::qgis_run_algorithm("sagang:topographiccorrection", `DEM` = DEM, `ORIGINAL` = ORIGINAL, `CORRECTED` = CORRECTED, `AZI` = AZI, `HGT` = HGT, `METHOD` = METHOD, `MINNAERT` = MINNAERT, `MAXCELLS` = MAXCELLS, `MAXVALUE` = MAXVALUE,..., .quiet = .quiet)
      )
  }

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