sagang_snappointstogrid: QGIS algorithm - Snap points to grid

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

QGIS algorithm - Snap points to grid

Description

QGIS Algorithm provided by SAGA Next Gen Snap points to grid (sagang:snappointstogrid). —————- Arguments —————- INPUT: Points Argument type: source Acceptable values: - Path to a vector layer GRID: Grid Argument type: raster Acceptable values: - Path to a raster layer OUTPUT: Result Argument type: vectorDestination Acceptable values: - Path for new vector layer MOVES: Moves Argument type: vectorDestination Acceptable values: - Path for new vector layer DISTANCE: Search Distance (Map Units) Default value: 0 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 SHAPE: Search Shape Default value: 0 Argument type: enum Available values: - 0: (0) circle - 1: (1) square Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' EXTREME: Extreme Default value: 1 Argument type: enum Available values: - 0: (0) minimum - 1: (1) maximum Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3'

Usage

sagang_snappointstogrid(
  INPUT = qgisprocess:::qgis_default_value(),
  GRID = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  MOVES = qgisprocess:::qgis_default_value(),
  DISTANCE = qgisprocess:::qgis_default_value(),
  SHAPE = qgisprocess:::qgis_default_value(),
  EXTREME = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT	source - Points. Path to a vector layer.
GRID	raster - Grid. Path to a raster layer.
OUTPUT	vectorDestination - Result. Path for new vector layer.
MOVES	vectorDestination - Moves. Path for new vector layer.
DISTANCE	number - Search Distance (Map Units). 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.
SHAPE	enum of ⁠("(0) circle", "(1) square")⁠ - Search Shape. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
EXTREME	enum of ⁠("(0) minimum", "(1) maximum")⁠ - Extreme. 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

• MOVES - outputVector - Moves

• OUTPUT - outputVector - Result

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