sagang_localminimaandmaxima: QGIS algorithm - Local minima and maxima

View source: R/sagang_localminimaandmaxima.R

sagang_localminimaandmaximaR Documentation

QGIS algorithm - Local minima and maxima

Description

QGIS Algorithm provided by SAGA Next Gen Local minima and maxima (sagang:localminimaandmaxima). —————- Arguments —————- GRID: Grid Argument type: raster Acceptable values: - Path to a raster layer MINIMA: Minima Argument type: vectorDestination Acceptable values: - Path for new vector layer MAXIMA: Maxima Argument type: vectorDestination Acceptable values: - Path for new vector layer IDENTITY: Identical Values Default value: false Argument type: boolean Acceptable values: - 1 for true/yes - 0 for false/no - 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 ABSOLUTE: Absolute Default value: false Argument type: boolean Acceptable values: - 1 for true/yes - 0 for false/no - 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 BOUNDARY: Boundary Cells Default value: false Argument type: boolean Acceptable values: - 1 for true/yes - 0 for false/no - 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_localminimaandmaxima(
  GRID = qgisprocess:::qgis_default_value(),
  MINIMA = qgisprocess:::qgis_default_value(),
  MAXIMA = qgisprocess:::qgis_default_value(),
  IDENTITY = qgisprocess:::qgis_default_value(),
  ABSOLUTE = qgisprocess:::qgis_default_value(),
  BOUNDARY = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

GRID

raster - Grid. Path to a raster layer.

MINIMA

vectorDestination - Minima. Path for new vector layer.

MAXIMA

vectorDestination - Maxima. Path for new vector layer.

IDENTITY

boolean - Identical Values. 1 for true/yes. 0 for false/no. 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.

ABSOLUTE

boolean - Absolute. 1 for true/yes. 0 for false/no. 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.

BOUNDARY

boolean - Boundary Cells. 1 for true/yes. 0 for false/no. 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

  • MAXIMA - outputVector - Maxima

  • MINIMA - outputVector - Minima


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