sagang_rastervaluestopoints: QGIS algorithm - Raster values to points

View source: R/sagang_rastervaluestopoints.R

sagang_rastervaluestopointsR Documentation

QGIS algorithm - Raster values to points

Description

QGIS Algorithm provided by SAGA Next Gen Raster values to points (sagang:rastervaluestopoints). —————- Arguments —————- GRIDS: Grids Argument type: multilayer POLYGONS: Polygons (optional) Argument type: source Acceptable values: - Path to a vector layer SHAPES: Shapes Argument type: vectorDestination Acceptable values: - Path for new vector layer NODATA: Exclude NoData Cells Default value: true 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 TYPE: Type Default value: 0 Argument type: enum Available values: - 0: (0) nodes - 1: (1) cells Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3'

Usage

sagang_rastervaluestopoints(
  GRIDS = qgisprocess:::qgis_default_value(),
  POLYGONS = qgisprocess:::qgis_default_value(),
  SHAPES = qgisprocess:::qgis_default_value(),
  NODATA = qgisprocess:::qgis_default_value(),
  TYPE = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

GRIDS

multilayer - Grids. .

POLYGONS

source - Polygons. Path to a vector layer.

SHAPES

vectorDestination - Shapes. Path for new vector layer.

NODATA

boolean - Exclude NoData 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.

TYPE

enum of ⁠("(0) nodes", "(1) cells")⁠ - Type. 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

  • SHAPES - outputVector - Shapes


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