grass_i_atcorr: QGIS algorithm - i.atcorr

View source: R/grass_i_atcorr.R

grass_i_atcorrR Documentation

QGIS algorithm - i.atcorr

Description

QGIS Algorithm provided by GRASS i.atcorr (grass:i.atcorr). Performs atmospheric correction using the 6S algorithm.

Usage

grass_i_atcorr(
  input = qgisprocess:::qgis_default_value(),
  range = qgisprocess:::qgis_default_value(),
  elevation = qgisprocess:::qgis_default_value(),
  visibility = qgisprocess:::qgis_default_value(),
  parameters = qgisprocess:::qgis_default_value(),
  rescale = qgisprocess:::qgis_default_value(),
  output = qgisprocess:::qgis_default_value(),
  .i = qgisprocess:::qgis_default_value(),
  .r = qgisprocess:::qgis_default_value(),
  .a = qgisprocess:::qgis_default_value(),
  .b = qgisprocess:::qgis_default_value(),
  GRASS_REGION_PARAMETER = qgisprocess:::qgis_default_value(),
  GRASS_REGION_CELLSIZE_PARAMETER = qgisprocess:::qgis_default_value(),
  GRASS_RASTER_FORMAT_OPT = qgisprocess:::qgis_default_value(),
  GRASS_RASTER_FORMAT_META = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

input

raster - Name of input raster map. Path to a raster layer.

range

range - Input imagery range (0,255). Two comma separated numeric values, e.g. '1,10'.

elevation

raster - Input altitude raster map in m (optional). Path to a raster layer.

visibility

raster - Input visibility raster map in km (optional). Path to a raster layer.

parameters

file - Name of input text file. Path to a file.

rescale

range - Rescale output raster map (0,255). Two comma separated numeric values, e.g. '1,10'.

output

rasterDestination - Atmospheric correction. Path for new raster layer.

.i

boolean - Output raster map as integer. 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: -i.

.r

boolean - Input raster map converted to reflectance (default is radiance). 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: -r.

.a

boolean - Input from ETM+ image taken after July 1, 2000. 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: -a.

.b

boolean - Input from ETM+ image taken before July 1, 2000. 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: -b.

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.

GRASS_RASTER_FORMAT_OPT

string - Output Rasters format options (createopt). String 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.

GRASS_RASTER_FORMAT_META

string - Output Rasters format metadata options (metaopt). String 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 - outputRaster - Atmospheric correction


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