sagang_geodesicmorphologicalreconstruction: QGIS algorithm - Geodesic morphological reconstruction

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

QGIS algorithm - Geodesic morphological reconstruction

Description

QGIS Algorithm provided by SAGA Next Gen Geodesic morphological reconstruction (sagang:geodesicmorphologicalreconstruction). —————- Arguments —————- INPUT_GRID: Input Grid Argument type: raster Acceptable values: - Path to a raster layer OBJECT_GRID: Object Grid Argument type: rasterDestination Acceptable values: - Path for new raster layer DIFFERENCE_GRID: Difference Input - Reconstruction Argument type: rasterDestination Acceptable values: - Path for new raster layer SHIFT_VALUE: Shift value Default value: 5 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 BORDER_YES_NO: Preserve 1px border Yes/No 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 BIN_YES_NO: Create a binary mask Yes/No 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 THRESHOLD: Threshold Default value: 1 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_geodesicmorphologicalreconstruction(
  INPUT_GRID = qgisprocess:::qgis_default_value(),
  OBJECT_GRID = qgisprocess:::qgis_default_value(),
  DIFFERENCE_GRID = qgisprocess:::qgis_default_value(),
  SHIFT_VALUE = qgisprocess:::qgis_default_value(),
  BORDER_YES_NO = qgisprocess:::qgis_default_value(),
  BIN_YES_NO = qgisprocess:::qgis_default_value(),
  THRESHOLD = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT_GRID	raster - Input Grid. Path to a raster layer.
OBJECT_GRID	rasterDestination - Object Grid. Path for new raster layer.
DIFFERENCE_GRID	rasterDestination - Difference Input - Reconstruction. Path for new raster layer.
SHIFT_VALUE	number - Shift value. 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.
BORDER_YES_NO	boolean - Preserve 1px border Yes/No. 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.
BIN_YES_NO	boolean - Create a binary mask Yes/No. 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.
THRESHOLD	number - Threshold. 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

• DIFFERENCE_GRID - outputRaster - Difference Input - Reconstruction

• OBJECT_GRID - outputRaster - Object Grid

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