qgis_setzfromraster: QGIS algorithm - Drape (set Z value from raster)

View source: R/qgis_setzfromraster.R

qgis_setzfromrasterR Documentation

QGIS algorithm - Drape (set Z value from raster)

Description

QGIS Algorithm provided by QGIS (native c++) Drape (set Z value from raster) (native:setzfromraster). Sets the z value for vertices to values sampled from a raster layer. This algorithm sets the z value of every vertex in the feature geometry to a value sampled from a band within a raster layer. The raster values can optionally be scaled by a preset amount and an offset can be algebraically added.

Usage

qgis_setzfromraster(
  INPUT = qgisprocess:::qgis_default_value(),
  RASTER = qgisprocess:::qgis_default_value(),
  BAND = qgisprocess:::qgis_default_value(),
  NODATA = qgisprocess:::qgis_default_value(),
  SCALE = qgisprocess:::qgis_default_value(),
  OFFSET = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT

source - Input layer. Path to a vector layer.

RASTER

raster - Raster layer. Path to a raster layer.

BAND

band - Band number. Integer value representing an existing raster band number.

NODATA

number - Value for NoData or non-intersecting vertices. 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.

SCALE

number - Scale factor. 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.

OFFSET

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

OUTPUT

sink - Draped. Path for new vector layer.

...

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

  • OUTPUT - outputVector - Draped


JanCaha/r_package_qgis documentation built on April 4, 2024, 8:10 p.m.