sagang_gradientvectorsfromdirectionalcomponents: QGIS algorithm - Gradient vectors from directional components

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

QGIS algorithm - Gradient vectors from directional components

Description

QGIS Algorithm provided by SAGA Next Gen Gradient vectors from directional components (sagang:gradientvectorsfromdirectionalcomponents). —————- Arguments —————- X: X Component Argument type: raster Acceptable values: - Path to a raster layer Y: Y Component Argument type: raster Acceptable values: - Path to a raster layer VECTORS: Gradient Vectors Argument type: vectorDestination Acceptable values: - Path for new vector layer STEP: Step 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 AGGR: Aggregation Default value: 1 Argument type: enum Available values: - 0: (0) nearest neighbour - 1: (1) mean value Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' STYLE: Style Default value: 2 Argument type: enum Available values: - 0: (0) simple line - 1: (1) arrow - 2: (2) arrow (centered to cell) Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3'

Usage

sagang_gradientvectorsfromdirectionalcomponents(
  X = qgisprocess:::qgis_default_value(),
  Y = qgisprocess:::qgis_default_value(),
  VECTORS = qgisprocess:::qgis_default_value(),
  STEP = qgisprocess:::qgis_default_value(),
  AGGR = qgisprocess:::qgis_default_value(),
  STYLE = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

X	raster - X Component. Path to a raster layer.
Y	raster - Y Component. Path to a raster layer.
VECTORS	vectorDestination - Gradient Vectors. Path for new vector layer.
STEP	number - Step. 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.
AGGR	enum of ⁠("(0) nearest neighbour", "(1) mean value")⁠ - Aggregation. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
STYLE	enum of ⁠("(0) simple line", "(1) arrow", "(2) arrow (centered to cell)")⁠ - Style. 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

• VECTORS - outputVector - Gradient Vectors

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