sagang_focalpcaonagrid: QGIS algorithm - Focal pca on a grid

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

QGIS algorithm - Focal pca on a grid

Description

QGIS Algorithm provided by SAGA Next Gen Focal pca on a grid (sagang:focalpcaonagrid). —————- Arguments —————- GRID: Grid Argument type: raster Acceptable values: - Path to a raster layer BASE: Base Topographies Argument type: rasterDestination Acceptable values: - Path for new raster layer PCA: Principal Components Argument type: rasterDestination Acceptable values: - Path for new raster layer EIGEN: Eigen Vectors Argument type: vectorDestination Acceptable values: - Path for new vector layer COMPONENTS: Number of Components Default value: 7 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 BASE_OUT: Output of Base Topographies 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 OVERWRITE: Overwrite Previous Results 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 KERNEL_TYPE: Kernel Type Default value: 1 Argument type: enum Available values: - 0: (0) Square - 1: (1) Circle Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' KERNEL_RADIUS: Kernel Radius Default value: 2 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 METHOD: Method Default value: 1 Argument type: enum Available values: - 0: (0) correlation matrix - 1: (1) variance-covariance matrix - 2: (2) sums-of-squares-and-cross-products matrix Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3'

Usage

sagang_focalpcaonagrid(
  GRID = qgisprocess:::qgis_default_value(),
  BASE = qgisprocess:::qgis_default_value(),
  PCA = qgisprocess:::qgis_default_value(),
  EIGEN = qgisprocess:::qgis_default_value(),
  COMPONENTS = qgisprocess:::qgis_default_value(),
  BASE_OUT = qgisprocess:::qgis_default_value(),
  OVERWRITE = qgisprocess:::qgis_default_value(),
  KERNEL_TYPE = qgisprocess:::qgis_default_value(),
  KERNEL_RADIUS = qgisprocess:::qgis_default_value(),
  METHOD = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

GRID	raster - Grid. Path to a raster layer.
BASE	rasterDestination - Base Topographies. Path for new raster layer.
PCA	rasterDestination - Principal Components. Path for new raster layer.
EIGEN	vectorDestination - Eigen Vectors. Path for new vector layer.
COMPONENTS	number - Number of Components. 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.
BASE_OUT	boolean - Output of Base Topographies. 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.
OVERWRITE	boolean - Overwrite Previous Results. 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.
KERNEL_TYPE	enum of ⁠("(0) Square", "(1) Circle")⁠ - Kernel Type. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
KERNEL_RADIUS	number - Kernel Radius. 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.
METHOD	enum of ⁠("(0) correlation matrix", "(1) variance-covariance matrix", "(2) sums-of-squares-and-cross-products matrix")⁠ - Method. 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

• BASE - outputRaster - Base Topographies

• EIGEN - outputVector - Eigen Vectors

• PCA - outputRaster - Principal Components

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