grass_i_cluster: QGIS algorithm - i.cluster

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

QGIS algorithm - i.cluster

Description

QGIS Algorithm provided by GRASS i.cluster (grass:i.cluster). Generates spectral signatures for land cover types in an image using a clustering algorithm.

Usage

grass_i_cluster(
  input = qgisprocess:::qgis_default_value(),
  classes = qgisprocess:::qgis_default_value(),
  seed = qgisprocess:::qgis_default_value(),
  sample = qgisprocess:::qgis_default_value(),
  iterations = qgisprocess:::qgis_default_value(),
  convergence = qgisprocess:::qgis_default_value(),
  separation = qgisprocess:::qgis_default_value(),
  min_size = qgisprocess:::qgis_default_value(),
  signaturefile = qgisprocess:::qgis_default_value(),
  reportfile = qgisprocess:::qgis_default_value(),
  GRASS_REGION_PARAMETER = qgisprocess:::qgis_default_value(),
  GRASS_REGION_CELLSIZE_PARAMETER = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

input	multilayer - Input rasters. .
classes	number - Initial number of classes (1-255). 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.
seed	file - Name of file containing initial signatures. Path to a file.
sample	string - Sampling intervals (by row and col). String 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.
iterations	number - Maximum number of 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.
convergence	number - Percent convergence. 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.
separation	number - Cluster separation. 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.
min_size	number - Minimum number of pixels in a class. 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.
signaturefile	fileDestination - Signature File. Path for new file.
reportfile	fileDestination - Final Report File. Path for new file.
GRASS_REGION_PARAMETER	extent - GRASS GIS region extent. A comma delimited string of x min, x max, y min, y max. E.g. '4,10,101,105'. Path to a layer. The extent of the layer is used..
GRASS_REGION_CELLSIZE_PARAMETER	number - GRASS GIS region cellsize (leave 0 for default). 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

• reportfile - outputFile - Final Report File

• signaturefile - outputFile - Signature File

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