sagang_vegetationindexdistancebased: QGIS algorithm - Vegetation index (distance based)

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

QGIS algorithm - Vegetation index (distance based)

Description

QGIS Algorithm provided by SAGA Next Gen Vegetation index (distance based) (sagang:vegetationindexdistancebased). —————- 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 PVI0: Perpendicular Vegetation Index (Richardson and Wiegand, 1977) Argument type: rasterDestination Acceptable values: - Path for new raster layer PVI1: Perpendicular Vegetation Index (Perry and Lautenschlager, 1984) Argument type: rasterDestination Acceptable values: - Path for new raster layer PVI2: Perpendicular Vegetation Index (Walther and Shabaani) Argument type: rasterDestination Acceptable values: - Path for new raster layer PVI3: Perpendicular Vegetation Index (Qi, et al., 1994) Argument type: rasterDestination Acceptable values: - Path for new raster layer TSAVI: Transformed Soil Adjusted Vegetation Index (Baret et al. 1989) Argument type: rasterDestination Acceptable values: - Path for new raster layer ATSAVI: Transformed Soil Adjusted Vegetation Index (Baret and Guyot, 1991) Argument type: rasterDestination Acceptable values: - Path for new raster layer INTERCEPT: Intercept of Soil Line Default value: 0 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 SLOPE: Slope of Soil Line 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_vegetationindexdistancebased(
  RED = qgisprocess:::qgis_default_value(),
  NIR = qgisprocess:::qgis_default_value(),
  PVI0 = qgisprocess:::qgis_default_value(),
  PVI1 = qgisprocess:::qgis_default_value(),
  PVI2 = qgisprocess:::qgis_default_value(),
  PVI3 = qgisprocess:::qgis_default_value(),
  TSAVI = qgisprocess:::qgis_default_value(),
  ATSAVI = qgisprocess:::qgis_default_value(),
  INTERCEPT = qgisprocess:::qgis_default_value(),
  SLOPE = 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.
PVI0	rasterDestination - Perpendicular Vegetation Index (Richardson and Wiegand, 1977). Path for new raster layer.
PVI1	rasterDestination - Perpendicular Vegetation Index (Perry and Lautenschlager, 1984). Path for new raster layer.
PVI2	rasterDestination - Perpendicular Vegetation Index (Walther and Shabaani). Path for new raster layer.
PVI3	rasterDestination - Perpendicular Vegetation Index (Qi, et al., 1994). Path for new raster layer.
TSAVI	rasterDestination - Transformed Soil Adjusted Vegetation Index (Baret et al. 1989). Path for new raster layer.
ATSAVI	rasterDestination - Transformed Soil Adjusted Vegetation Index (Baret and Guyot, 1991). Path for new raster layer.
INTERCEPT	number - Intercept of Soil Line. 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.
SLOPE	number - Slope of Soil Line. 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

• ATSAVI - outputRaster - Transformed Soil Adjusted Vegetation Index (Baret and Guyot, 1991)

• PVI0 - outputRaster - Perpendicular Vegetation Index (Richardson and Wiegand, 1977)

• PVI1 - outputRaster - Perpendicular Vegetation Index (Perry and Lautenschlager, 1984)

• PVI2 - outputRaster - Perpendicular Vegetation Index (Walther and Shabaani)

• PVI3 - outputRaster - Perpendicular Vegetation Index (Qi, et al., 1994)

• TSAVI - outputRaster - Transformed Soil Adjusted Vegetation Index (Baret et al. 1989)

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