sagang_rastermasking: QGIS algorithm - Raster masking

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

QGIS algorithm - Raster masking

Description

QGIS Algorithm provided by SAGA Next Gen Raster masking (sagang:rastermasking). —————- Arguments —————- LIST: List Processing 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 GRID: Grid Argument type: raster Acceptable values: - Path to a raster layer MASKED: Masked Grid Argument type: rasterDestination Acceptable values: - Path for new raster layer GRIDS: Grids Argument type: multilayer GRIDS_CREATE: Create Copies 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 GRIDS_MASKED: Masked Grids Argument type: rasterDestination Acceptable values: - Path for new raster layer MASK: Mask Argument type: raster Acceptable values: - Path to a raster layer NODATA: Mask Cells Default value: 0 Argument type: enum Available values: - 0: (0) no-data cells - 1: (1) data cells Acceptable values: - Number of selected option, e.g. '1' - Comma separated list of options, e.g. '1,3'

Usage

sagang_rastermasking(
  LIST = qgisprocess:::qgis_default_value(),
  GRID = qgisprocess:::qgis_default_value(),
  MASKED = qgisprocess:::qgis_default_value(),
  GRIDS = qgisprocess:::qgis_default_value(),
  GRIDS_CREATE = qgisprocess:::qgis_default_value(),
  GRIDS_MASKED = qgisprocess:::qgis_default_value(),
  MASK = qgisprocess:::qgis_default_value(),
  NODATA = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

LIST	boolean - List Processing. 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.
GRID	raster - Grid. Path to a raster layer.
MASKED	rasterDestination - Masked Grid. Path for new raster layer.
GRIDS	multilayer - Grids. .
GRIDS_CREATE	boolean - Create Copies. 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.
GRIDS_MASKED	rasterDestination - Masked Grids. Path for new raster layer.
MASK	raster - Mask. Path to a raster layer.
NODATA	enum of ⁠("(0) no-data cells", "(1) data cells")⁠ - Mask Cells. Number of selected option, e.g. '1'. Comma separated list of options, e.g. '1,3'.
...	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

• GRIDS_MASKED - outputRaster - Masked Grids

• MASKED - outputRaster - Masked Grid

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