sagang_vegetationindexslopebased: QGIS algorithm - Vegetation index (slope based)

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

QGIS algorithm - Vegetation index (slope based)

Description

QGIS Algorithm provided by SAGA Next Gen Vegetation index (slope based) (sagang:vegetationindexslopebased). —————- Arguments —————- RED: Red Reflectance Argument type: raster Acceptable values: - Path to a raster layer NIR: Near Infrared Reflectance Argument type: raster Acceptable values: - Path to a raster layer DVI: Difference Vegetation Index Argument type: rasterDestination Acceptable values: - Path for new raster layer NDVI: Normalized Difference Vegetation Index Argument type: rasterDestination Acceptable values: - Path for new raster layer RVI: Ratio Vegetation Index Argument type: rasterDestination Acceptable values: - Path for new raster layer NRVI: Normalized Ratio Vegetation Index Argument type: rasterDestination Acceptable values: - Path for new raster layer TVI: Transformed Vegetation Index Argument type: rasterDestination Acceptable values: - Path for new raster layer CTVI: Corrected Transformed Vegetation Index Argument type: rasterDestination Acceptable values: - Path for new raster layer TTVI: Thiam's Transformed Vegetation Index Argument type: rasterDestination Acceptable values: - Path for new raster layer SAVI: Soil Adjusted Vegetation Index Argument type: rasterDestination Acceptable values: - Path for new raster layer SOIL: Soil Adjustment Factor 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

Usage

sagang_vegetationindexslopebased(
  RED = qgisprocess:::qgis_default_value(),
  NIR = qgisprocess:::qgis_default_value(),
  DVI = qgisprocess:::qgis_default_value(),
  NDVI = qgisprocess:::qgis_default_value(),
  RVI = qgisprocess:::qgis_default_value(),
  NRVI = qgisprocess:::qgis_default_value(),
  TVI = qgisprocess:::qgis_default_value(),
  CTVI = qgisprocess:::qgis_default_value(),
  TTVI = qgisprocess:::qgis_default_value(),
  SAVI = qgisprocess:::qgis_default_value(),
  SOIL = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

RED	raster - Red Reflectance. Path to a raster layer.
NIR	raster - Near Infrared Reflectance. Path to a raster layer.
DVI	rasterDestination - Difference Vegetation Index. Path for new raster layer.
NDVI	rasterDestination - Normalized Difference Vegetation Index. Path for new raster layer.
RVI	rasterDestination - Ratio Vegetation Index. Path for new raster layer.
NRVI	rasterDestination - Normalized Ratio Vegetation Index. Path for new raster layer.
TVI	rasterDestination - Transformed Vegetation Index. Path for new raster layer.
CTVI	rasterDestination - Corrected Transformed Vegetation Index. Path for new raster layer.
TTVI	rasterDestination - Thiam's Transformed Vegetation Index. Path for new raster layer.
SAVI	rasterDestination - Soil Adjusted Vegetation Index. Path for new raster layer.
SOIL	number - Soil Adjustment Factor. 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

• CTVI - outputRaster - Corrected Transformed Vegetation Index

• DVI - outputRaster - Difference Vegetation Index

• NDVI - outputRaster - Normalized Difference Vegetation Index

• NRVI - outputRaster - Normalized Ratio Vegetation Index

• RVI - outputRaster - Ratio Vegetation Index

• SAVI - outputRaster - Soil Adjusted Vegetation Index

• TTVI - outputRaster - Thiam's Transformed Vegetation Index

• TVI - outputRaster - Transformed Vegetation Index

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