qgis_relief: QGIS algorithm - Relief

View source: R/qgis_relief.R

qgis_reliefR Documentation

QGIS algorithm - Relief

Description

QGIS Algorithm provided by QGIS Relief (qgis:relief). This algorithm creates a shaded relief layer from digital elevation data.

Usage

qgis_relief(
  INPUT = qgisprocess:::qgis_default_value(),
  Z_FACTOR = qgisprocess:::qgis_default_value(),
  AUTO_COLORS = qgisprocess:::qgis_default_value(),
  COLORS = qgisprocess:::qgis_default_value(),
  OUTPUT = qgisprocess:::qgis_default_value(),
  FREQUENCY_DISTRIBUTION = qgisprocess:::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT

raster - Elevation layer. Path to a raster layer.

Z_FACTOR

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

AUTO_COLORS

boolean - Generate relief classes automatically. 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.

COLORS

relief_colors - Relief colors. .

OUTPUT

rasterDestination - Relief. Path for new raster layer.

FREQUENCY_DISTRIBUTION

fileDestination - Frequency distribution. Path for new file.

...

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

  • FREQUENCY_DISTRIBUTION - outputFile - Frequency distribution

  • OUTPUT - outputRaster - Relief


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