grass_i_topo_corr: QGIS algorithm - i.topo.corr

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

QGIS algorithm - i.topo.corr

Description

QGIS Algorithm provided by GRASS i.topo.corr (grass:i.topo.corr). Computes topographic correction of reflectance.

Usage

grass_i_topo_corr(
  input = qgisprocess:::qgis_default_value(),
  basemap = qgisprocess:::qgis_default_value(),
  zenith = qgisprocess:::qgis_default_value(),
  method = qgisprocess:::qgis_default_value(),
  .s = qgisprocess:::qgis_default_value(),
  output = qgisprocess:::qgis_default_value(),
  GRASS_REGION_PARAMETER = qgisprocess:::qgis_default_value(),
  GRASS_REGION_CELLSIZE_PARAMETER = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

input	multilayer - Name of reflectance raster maps to be corrected topographically. .
basemap	raster - Name of illumination input base raster map. Path to a raster layer.
zenith	number - Solar zenith in degrees. 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	enum of ⁠("cosine", "minnaert", "c-factor", "percent")⁠ - Topographic correction method. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
.s	boolean - Scale output to input and copy color rules. 1 for true/yes. 0 for false/no. 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. Original algorithm parameter name: -s.
output	folderDestination - Output Directory. Path for an existing or new folder.
GRASS_REGION_PARAMETER	extent - GRASS GIS region extent. A comma delimited string of x min, x max, y min, y max. E.g. '4,10,101,105'. Path to a layer. The extent of the layer is used..
GRASS_REGION_CELLSIZE_PARAMETER	number - GRASS GIS region cellsize (leave 0 for default). 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.
...	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

• output - outputFolder - Output Directory

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