sagang_flatdetection: QGIS algorithm - Flat detection

View source: R/sagang_flatdetection.R

sagang_flatdetectionR Documentation

QGIS algorithm - Flat detection

Description

QGIS Algorithm provided by SAGA Next Gen Flat detection (sagang:flatdetection). —————- Arguments —————- DEM: DEM Argument type: raster Acceptable values: - Path to a raster layer NOFLATS: No Flats Argument type: rasterDestination Acceptable values: - Path for new raster layer FLATS: Flat Areas Argument type: rasterDestination Acceptable values: - Path for new raster layer FLAT_OUTPUT: Flat Area Values Default value: 0 Argument type: enum Available values: - 0: (0) elevation - 1: (1) enumeration Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3'

Usage

sagang_flatdetection(
  DEM = qgisprocess:::qgis_default_value(),
  NOFLATS = qgisprocess:::qgis_default_value(),
  FLATS = qgisprocess:::qgis_default_value(),
  FLAT_OUTPUT = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

DEM

raster - DEM. Path to a raster layer.

NOFLATS

rasterDestination - No Flats. Path for new raster layer.

FLATS

rasterDestination - Flat Areas. Path for new raster layer.

FLAT_OUTPUT

enum of ⁠("(0) elevation", "(1) enumeration")⁠ - Flat Area Values. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

...

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

  • FLATS - outputRaster - Flat Areas

  • NOFLATS - outputRaster - No Flats


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