sagang_rasterproximitybuffer: QGIS algorithm - Raster proximity buffer

View source: R/sagang_rasterproximitybuffer.R

sagang_rasterproximitybufferR Documentation

QGIS algorithm - Raster proximity buffer

Description

QGIS Algorithm provided by SAGA Next Gen Raster proximity buffer (sagang:rasterproximitybuffer). —————- Arguments —————- SOURCE: Source Grid Argument type: raster Acceptable values: - Path to a raster layer DISTANCE: Distance Grid Argument type: rasterDestination Acceptable values: - Path for new raster layer ALLOC: Allocation Grid Argument type: rasterDestination Acceptable values: - Path for new raster layer BUFFER: Buffer Grid Argument type: rasterDestination Acceptable values: - Path for new raster layer DIST: Buffer distance Default value: 500 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 IVAL: Equidistance 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

Usage

sagang_rasterproximitybuffer(
  SOURCE = qgisprocess:::qgis_default_value(),
  DISTANCE = qgisprocess:::qgis_default_value(),
  ALLOC = qgisprocess:::qgis_default_value(),
  BUFFER = qgisprocess:::qgis_default_value(),
  DIST = qgisprocess:::qgis_default_value(),
  IVAL = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

SOURCE

raster - Source Grid. Path to a raster layer.

DISTANCE

rasterDestination - Distance Grid. Path for new raster layer.

ALLOC

rasterDestination - Allocation Grid. Path for new raster layer.

BUFFER

rasterDestination - Buffer Grid. Path for new raster layer.

DIST

number - Buffer distance. 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.

IVAL

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

  • ALLOC - outputRaster - Allocation Grid

  • BUFFER - outputRaster - Buffer Grid

  • DISTANCE - outputRaster - Distance Grid


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