sagang_terrainclustering: QGIS algorithm - Terrain clustering

View source: R/sagang_terrainclustering.R

sagang_terrainclusteringR Documentation

QGIS algorithm - Terrain clustering

Description

QGIS Algorithm provided by SAGA Next Gen Terrain clustering (sagang:terrainclustering). —————- Arguments —————- ELEVATION: Elevation Argument type: raster Acceptable values: - Path to a raster layer CLUSTER: Clusters Argument type: rasterDestination Acceptable values: - Path for new raster layer NCLUSTER: Number of Terrain Classes Default value: 5 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 MAXITER: Maximum Iterations Default value: 25 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

Usage

sagang_terrainclustering(
  ELEVATION = qgisprocess:::qgis_default_value(),
  CLUSTER = qgisprocess:::qgis_default_value(),
  NCLUSTER = qgisprocess:::qgis_default_value(),
  MAXITER = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

ELEVATION

raster - Elevation. Path to a raster layer.

CLUSTER

rasterDestination - Clusters. Path for new raster layer.

NCLUSTER

number - Number of Terrain Classes. 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.

MAXITER

number - Maximum Iterations. 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.

...

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

  • CLUSTER - outputRaster - Clusters


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