sagang_histogrammatching: QGIS algorithm - Histogram matching

View source: R/sagang_histogrammatching.R

sagang_histogrammatchingR Documentation

QGIS algorithm - Histogram matching

Description

QGIS Algorithm provided by SAGA Next Gen Histogram matching (sagang:histogrammatching). —————- Arguments —————- GRID: Grid Argument type: raster Acceptable values: - Path to a raster layer MATCHED: Adjusted Grid Argument type: rasterDestination Acceptable values: - Path for new raster layer REFERENCE: Reference Grid Argument type: raster Acceptable values: - Path to a raster layer METHOD: Method Default value: 1 Argument type: enum Available values: - 0: (0) standard deviation - 1: (1) histogram Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' NCLASSES: Histogramm Classes Default value: 100 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 MAXSAMPLES: Maximum Sample Size Default value: 1e+06 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_histogrammatching(
  GRID = qgisprocess:::qgis_default_value(),
  MATCHED = qgisprocess:::qgis_default_value(),
  REFERENCE = qgisprocess:::qgis_default_value(),
  METHOD = qgisprocess:::qgis_default_value(),
  NCLASSES = qgisprocess:::qgis_default_value(),
  MAXSAMPLES = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

GRID

raster - Grid. Path to a raster layer.

MATCHED

rasterDestination - Adjusted Grid. Path for new raster layer.

REFERENCE

raster - Reference Grid. Path to a raster layer.

METHOD

enum of ⁠("(0) standard deviation", "(1) histogram")⁠ - Method. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.

NCLASSES

number - Histogramm 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.

MAXSAMPLES

number - Maximum Sample Size. 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

  • MATCHED - outputRaster - Adjusted Grid


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