grass_i_vi: QGIS algorithm - i.vi

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

QGIS algorithm - i.vi

Description

QGIS Algorithm provided by GRASS i.vi (grass:i.vi). Calculates different types of vegetation indices.

Usage

grass_i_vi(
  red = qgisprocess:::qgis_default_value(),
  viname = qgisprocess:::qgis_default_value(),
  nir = qgisprocess:::qgis_default_value(),
  green = qgisprocess:::qgis_default_value(),
  blue = qgisprocess:::qgis_default_value(),
  band5 = qgisprocess:::qgis_default_value(),
  band7 = qgisprocess:::qgis_default_value(),
  soil_line_slope = qgisprocess:::qgis_default_value(),
  soil_line_intercept = qgisprocess:::qgis_default_value(),
  soil_noise_reduction = qgisprocess:::qgis_default_value(),
  storage_bit = qgisprocess:::qgis_default_value(),
  output = 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

red	raster - Name of input red channel surface reflectance map (0.0-1.0). Path to a raster layer.
viname	enum of ⁠("arvi", "dvi", "evi", "evi2", "gvi", "gari", "gemi", "ipvi", "msavi", "msavi2", "ndvi", "pvi", "savi", "sr", "vari", "wdvi")⁠ - Type of vegetation index. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
nir	raster - Name of input nir channel surface reflectance map (0.0-1.0). Path to a raster layer.
green	raster - Name of input green channel surface reflectance map (0.0-1.0). Path to a raster layer.
blue	raster - Name of input blue channel surface reflectance map (0.0-1.0). Path to a raster layer.
band5	raster - Name of input 5th channel surface reflectance map (0.0-1.0). Path to a raster layer.
band7	raster - Name of input 7th channel surface reflectance map (0.0-1.0). Path to a raster layer.
soil_line_slope	number - Value of the slope of the soil line (MSAVI2 only). 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.
soil_line_intercept	number - Value of the factor of reduction of soil noise (MSAVI2 only). 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.
soil_noise_reduction	number - Value of the slope of the soil line (MSAVI2 only). 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.
storage_bit	enum of ⁠("7", "8", "9", "10", "16")⁠ - Maximum bits for digital numbers. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
output	rasterDestination - Vegetation Index. Path for new raster layer.
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 - Vegetation Index

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