sagang_confusionmatrixtwogrids: QGIS algorithm - Confusion matrix (two grids)

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

QGIS algorithm - Confusion matrix (two grids)

Description

QGIS Algorithm provided by SAGA Next Gen Confusion matrix (two grids) (sagang:confusionmatrixtwogrids). —————- Arguments —————- ONE: Classification 1 Argument type: raster Acceptable values: - Path to a raster layer ONE_LUT: Look-up Table (optional) Argument type: source Acceptable values: - Path to a vector layer ONE_LUT_MIN: Value Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names ONE_LUT_MAX: Value (Maximum) Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names ONE_LUT_NAM: Name Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names TWO: Classification 2 Argument type: raster Acceptable values: - Path to a raster layer TWO_LUT: Look-up Table (optional) Argument type: source Acceptable values: - Path to a vector layer TWO_LUT_MIN: Value Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names TWO_LUT_MAX: Value (Maximum) Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names TWO_LUT_NAM: Name Argument type: field Acceptable values: - The name of an existing field - ; delimited list of existing field names COMBINED: Combined Classes Argument type: rasterDestination Acceptable values: - Path for new raster layer NOCHANGE: Report Unchanged Classes 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 NODATA: Include Unclassified Cells 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 CONFUSION: Confusion Matrix Argument type: vectorDestination Acceptable values: - Path for new vector layer OUTPUT: Output as... Default value: 0 Argument type: enum Available values: - 0: (0) cells - 1: (1) percent - 2: (2) area Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' 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

Usage

sagang_confusionmatrixtwogrids(
  ONE = qgisprocess:::qgis_default_value(),
  ONE_LUT = qgisprocess:::qgis_default_value(),
  ONE_LUT_MIN = qgisprocess:::qgis_default_value(),
  ONE_LUT_MAX = qgisprocess:::qgis_default_value(),
  ONE_LUT_NAM = qgisprocess:::qgis_default_value(),
  TWO = qgisprocess:::qgis_default_value(),
  TWO_LUT = qgisprocess:::qgis_default_value(),
  TWO_LUT_MIN = qgisprocess:::qgis_default_value(),
  TWO_LUT_MAX = qgisprocess:::qgis_default_value(),
  TWO_LUT_NAM = qgisprocess:::qgis_default_value(),
  COMBINED = qgisprocess:::qgis_default_value(),
  NOCHANGE = qgisprocess:::qgis_default_value(),
  NODATA = qgisprocess:::qgis_default_value(),
  CONFUSION = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  CLASSES = qgisprocess:::qgis_default_value(),
  SUMMARY = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

ONE	raster - Classification 1. Path to a raster layer.
ONE_LUT	source - Look-up Table. Path to a vector layer.
ONE_LUT_MIN	field - Value. The name of an existing field. ; delimited list of existing field names.
ONE_LUT_MAX	field - Value (Maximum). The name of an existing field. ; delimited list of existing field names.
ONE_LUT_NAM	field - Name. The name of an existing field. ; delimited list of existing field names.
TWO	raster - Classification 2. Path to a raster layer.
TWO_LUT	source - Look-up Table. Path to a vector layer.
TWO_LUT_MIN	field - Value. The name of an existing field. ; delimited list of existing field names.
TWO_LUT_MAX	field - Value (Maximum). The name of an existing field. ; delimited list of existing field names.
TWO_LUT_NAM	field - Name. The name of an existing field. ; delimited list of existing field names.
COMBINED	rasterDestination - Combined Classes. Path for new raster layer.
NOCHANGE	boolean - Report Unchanged Classes. 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.
NODATA	boolean - Include Unclassified Cells. 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.
CONFUSION	vectorDestination - Confusion Matrix. Path for new vector layer.
OUTPUT	enum of ⁠("(0) cells", "(1) percent", "(2) area")⁠ - Output as.... Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
CLASSES	vectorDestination - Class Values. Path for new vector layer.
SUMMARY	vectorDestination - Summary. Path for new vector layer.
...	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

• COMBINED - outputRaster - Combined Classes

• CONFUSION - outputVector - Confusion Matrix

• SUMMARY - outputVector - Summary

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