sagang_vectorisinggridclasses: QGIS algorithm - Vectorising grid classes

View source: R/sagang_vectorisinggridclasses.R

sagang_vectorisinggridclassesR Documentation

QGIS algorithm - Vectorising grid classes

Description

QGIS Algorithm provided by SAGA Next Gen Vectorising grid classes (sagang:vectorisinggridclasses). —————- Arguments —————- GRID: Grid Argument type: raster Acceptable values: - Path to a raster layer POLYGONS: Polygons Argument type: vectorDestination Acceptable values: - Path for new vector layer CLASS_ALL: Class Selection Default value: 1 Argument type: enum Available values: - 0: (0) one single class specified by class identifier - 1: (1) all classes Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' CLASS_ID: Class Identifier Default value: 1 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 SPLIT: Vectorised class as... Default value: 0 Argument type: enum Available values: - 0: (0) one single (multi-)polygon object - 1: (1) each island as separated polygon Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' ALLVERTICES: Keep Vertices on Straight Lines 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_vectorisinggridclasses(
  GRID = qgisprocess:::qgis_default_value(),
  POLYGONS = qgisprocess:::qgis_default_value(),
  CLASS_ALL = qgisprocess:::qgis_default_value(),
  CLASS_ID = qgisprocess:::qgis_default_value(),
  SPLIT = qgisprocess:::qgis_default_value(),
  ALLVERTICES = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

GRID

raster - Grid. Path to a raster layer.

POLYGONS

vectorDestination - Polygons. Path for new vector layer.

CLASS_ALL

enum of ⁠("(0) one single class specified by class identifier", "(1) all classes")⁠ - Class Selection. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

CLASS_ID

number - Class Identifier. 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.

SPLIT

enum of ⁠("(0) one single (multi-)polygon object", "(1) each island as separated polygon")⁠ - Vectorised class as.... Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

ALLVERTICES

boolean - Keep Vertices on Straight Lines. 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

  • POLYGONS - outputVector - Polygons


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