gdal_tpitopographicpositionindex: QGIS algorithm Topographic Position Index (TPI)

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

QGIS algorithm Topographic Position Index (TPI)

Description

QGIS Algorithm provided by GDAL Topographic Position Index (TPI) (gdal:tpitopographicpositionindex)

Usage

gdal_tpitopographicpositionindex(
  INPUT = qgisprocess::qgis_default_value(),
  BAND = qgisprocess::qgis_default_value(),
  COMPUTE_EDGES = qgisprocess::qgis_default_value(),
  OPTIONS = qgisprocess::qgis_default_value(),
  OUTPUT = qgisprocess::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT	raster - Input layer. Path to a raster layer.
BAND	band - Band number. Integer value representing an existing raster band number.
COMPUTE_EDGES	boolean - Compute edges. 1 for true/yes. 0 for false/no.
OPTIONS	string - Additional creation options. String value.
OUTPUT	rasterDestination - Topographic Position Index. Path for new raster layer.
...	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 - Topographic Position Index

JanCaha/r_package_qgis documentation built on March 7, 2023, 7:17 a.m.