sagang_confusionmatrixpolygonsgrid: QGIS algorithm - Confusion matrix (polygons / grid)

View source: R/sagang_confusionmatrixpolygonsgrid.R

sagang_confusionmatrixpolygonsgridR Documentation

QGIS algorithm - Confusion matrix (polygons / grid)

Description

QGIS Algorithm provided by SAGA Next Gen Confusion matrix (polygons / grid) (sagang:confusionmatrixpolygonsgrid). —————- Arguments —————- GRID: Classification Argument type: raster Acceptable values: - Path to a raster layer GRID_VALUES: Value Interpretation Default value: 1 Argument type: enum Available values: - 0: (0) values are class identifiers - 1: (1) use look-up table Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' GRID_LUT: Look-up Table (optional) Argument type: source Acceptable values: - Path to a vector layer GRID_LUT_MIN: Value Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names GRID_LUT_MAX: Value (Maximum) Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names GRID_LUT_NAM: Name Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names POLYGONS: Polygons Argument type: source Acceptable values: - Path to a vector layer FIELD: Classes Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names CONFUSION: Confusion Matrix Argument type: vectorDestination Acceptable values: - Path for new vector layer CLASSES: Class Values Argument type: vectorDestination Acceptable values: - Path for new vector layer SUMMARY: Summary Argument type: vectorDestination Acceptable values: - Path for new vector layer NO_CLASS: Unclassified 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

Usage

sagang_confusionmatrixpolygonsgrid(
  GRID = qgisprocess:::qgis_default_value(),
  GRID_VALUES = qgisprocess:::qgis_default_value(),
  GRID_LUT = qgisprocess:::qgis_default_value(),
  GRID_LUT_MIN = qgisprocess:::qgis_default_value(),
  GRID_LUT_MAX = qgisprocess:::qgis_default_value(),
  GRID_LUT_NAM = qgisprocess:::qgis_default_value(),
  POLYGONS = qgisprocess:::qgis_default_value(),
  FIELD = qgisprocess:::qgis_default_value(),
  CONFUSION = qgisprocess:::qgis_default_value(),
  CLASSES = qgisprocess:::qgis_default_value(),
  SUMMARY = qgisprocess:::qgis_default_value(),
  NO_CLASS = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

GRID

raster - Classification. Path to a raster layer.

GRID_VALUES

enum of ⁠("(0) values are class identifiers", "(1) use look-up table")⁠ - Value Interpretation. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

GRID_LUT

source - Look-up Table. Path to a vector layer.

GRID_LUT_MIN

field - Value. The name of an existing field. ; delimited list of existing field names.

GRID_LUT_MAX

field - Value (Maximum). The name of an existing field. ; delimited list of existing field names.

GRID_LUT_NAM

field - Name. The name of an existing field. ; delimited list of existing field names.

POLYGONS

source - Polygons. Path to a vector layer.

FIELD

field - Classes. The name of an existing field. ; delimited list of existing field names.

CONFUSION

vectorDestination - Confusion Matrix. Path for new vector layer.

CLASSES

vectorDestination - Class Values. Path for new vector layer.

SUMMARY

vectorDestination - Summary. Path for new vector layer.

NO_CLASS

boolean - Unclassified. 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.

...

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

  • CLASSES - outputVector - Class Values

  • CONFUSION - outputVector - Confusion Matrix

  • SUMMARY - outputVector - Summary


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