sagang_universalimagequalityindex: QGIS algorithm - Universal image quality index

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

QGIS algorithm - Universal image quality index

Description

QGIS Algorithm provided by SAGA Next Gen Universal image quality index (sagang:universalimagequalityindex). —————- Arguments —————- GRID_A: First Grid Argument type: raster Acceptable values: - Path to a raster layer GRID_B: Second Grid Argument type: raster Acceptable values: - Path to a raster layer QUALITY: Universal Image Quality Index Argument type: rasterDestination Acceptable values: - Path for new raster layer CORRELATION: Correlation Argument type: rasterDestination Acceptable values: - Path for new raster layer LUMINANCE: Luminance Argument type: rasterDestination Acceptable values: - Path for new raster layer CONTRAST: Contrast Argument type: rasterDestination Acceptable values: - Path for new raster layer K1: k1 Default value: 0.01 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 K2: k2 Default value: 0.03 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 L: L Default value: 255 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 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: 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

Usage

sagang_universalimagequalityindex(
  GRID_A = qgisprocess:::qgis_default_value(),
  GRID_B = qgisprocess:::qgis_default_value(),
  QUALITY = qgisprocess:::qgis_default_value(),
  CORRELATION = qgisprocess:::qgis_default_value(),
  LUMINANCE = qgisprocess:::qgis_default_value(),
  CONTRAST = qgisprocess:::qgis_default_value(),
  K1 = qgisprocess:::qgis_default_value(),
  K2 = qgisprocess:::qgis_default_value(),
  L = qgisprocess:::qgis_default_value(),
  KERNEL_TYPE = qgisprocess:::qgis_default_value(),
  KERNEL_RADIUS = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

GRID_A	raster - First Grid. Path to a raster layer.
GRID_B	raster - Second Grid. Path to a raster layer.
QUALITY	rasterDestination - Universal Image Quality Index. Path for new raster layer.
CORRELATION	rasterDestination - Correlation. Path for new raster layer.
LUMINANCE	rasterDestination - Luminance. Path for new raster layer.
CONTRAST	rasterDestination - Contrast. Path for new raster layer.
K1	number - k1. 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.
K2	number - k2. 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.
L	number - L. 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.
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 - 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.
...	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

• CONTRAST - outputRaster - Contrast

• CORRELATION - outputRaster - Correlation

• LUMINANCE - outputRaster - Luminance

• QUALITY - outputRaster - Universal Image Quality Index

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