sagang_changegridvaluesfloodfill: QGIS algorithm - Change grid values - flood fill

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

QGIS algorithm - Change grid values - flood fill

Description

QGIS Algorithm provided by SAGA Next Gen Change grid values - flood fill (sagang:changegridvaluesfloodfill). —————- Arguments —————- POINTS: Points Argument type: source Acceptable values: - Path to a vector layer GRID: Grid Argument type: raster Acceptable values: - Path to a raster layer GRID_OUT: Changed Grid Argument type: rasterDestination Acceptable values: - Path for new raster layer REPLACE: Value to be replaced Default value: 0 Argument type: enum Available values: - 0: (0) value at mouse position - 1: (1) fixed value Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3' REPLACE_VALUE: Fixed value to be replaced Default value: 0 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 TOLERANCE: Tolerance 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 IGNORE_NODATA: Ignore No-Data 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 FILL_NODATA: Fill with No-Data Default value: false 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 FILL_VALUE: Fill Value Default value: 0 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_changegridvaluesfloodfill(
  POINTS = qgisprocess:::qgis_default_value(),
  GRID = qgisprocess:::qgis_default_value(),
  GRID_OUT = qgisprocess:::qgis_default_value(),
  REPLACE = qgisprocess:::qgis_default_value(),
  REPLACE_VALUE = qgisprocess:::qgis_default_value(),
  TOLERANCE = qgisprocess:::qgis_default_value(),
  IGNORE_NODATA = qgisprocess:::qgis_default_value(),
  FILL_NODATA = qgisprocess:::qgis_default_value(),
  FILL_VALUE = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

POINTS	source - Points. Path to a vector layer.
GRID	raster - Grid. Path to a raster layer.
GRID_OUT	rasterDestination - Changed Grid. Path for new raster layer.
REPLACE	enum of ⁠("(0) value at mouse position", "(1) fixed value")⁠ - Value to be replaced. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
REPLACE_VALUE	number - Fixed value to be replaced. 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.
TOLERANCE	number - Tolerance. 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.
IGNORE_NODATA	boolean - Ignore No-Data. 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.
FILL_NODATA	boolean - Fill with No-Data. 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.
FILL_VALUE	number - Fill 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.
...	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

• GRID_OUT - outputRaster - Changed Grid

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