sagang_summitextraction: QGIS algorithm - Summit extraction

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

QGIS algorithm - Summit extraction

Description

QGIS Algorithm provided by SAGA Next Gen Summit extraction (sagang:summitextraction). —————- Arguments —————- SURFACE: Surface Argument type: raster Acceptable values: - Path to a raster layer SUMMITS: Summits Argument type: vectorDestination Acceptable values: - Path for new vector layer METHOD: Trend Surface Default value: 0 Argument type: enum Available values: - 0: (0) Resampling Filter - 1: (1) Topographic Position Index (TPI) Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' SCALE_FILTER: Scale Default value: 10 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 SCALE_TPI: Scale Default value: 300 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 THRESHOLD: Threshold Default value: 10 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_summitextraction(
  SURFACE = qgisprocess:::qgis_default_value(),
  SUMMITS = qgisprocess:::qgis_default_value(),
  METHOD = qgisprocess:::qgis_default_value(),
  SCALE_FILTER = qgisprocess:::qgis_default_value(),
  SCALE_TPI = qgisprocess:::qgis_default_value(),
  THRESHOLD = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

SURFACE	raster - Surface. Path to a raster layer.
SUMMITS	vectorDestination - Summits. Path for new vector layer.
METHOD	enum of ⁠("(0) Resampling Filter", "(1) Topographic Position Index (TPI)")⁠ - Trend Surface. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
SCALE_FILTER	number - Scale. 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.
SCALE_TPI	number - Scale. 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.
THRESHOLD	number - Threshold. 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

• SUMMITS - outputVector - Summits

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