gdal_hillshade: QGIS algorithm Hillshade

View source: R/gdal_hillshade.R

gdal_hillshadeR Documentation

QGIS algorithm Hillshade

Description

QGIS Algorithm provided by GDAL Hillshade (gdal:hillshade)

Usage

gdal_hillshade(
  INPUT = qgisprocess::qgis_default_value(),
  BAND = qgisprocess::qgis_default_value(),
  Z_FACTOR = qgisprocess::qgis_default_value(),
  SCALE = qgisprocess::qgis_default_value(),
  AZIMUTH = qgisprocess::qgis_default_value(),
  ALTITUDE = qgisprocess::qgis_default_value(),
  COMPUTE_EDGES = qgisprocess::qgis_default_value(),
  ZEVENBERGEN = qgisprocess::qgis_default_value(),
  COMBINED = qgisprocess::qgis_default_value(),
  MULTIDIRECTIONAL = qgisprocess::qgis_default_value(),
  OPTIONS = qgisprocess::qgis_default_value(),
  EXTRA = qgisprocess::qgis_default_value(),
  OUTPUT = qgisprocess::qgis_default_value(),
  ...,
  .complete_output = .complete_output_option(),
  .quiet = .quiet_option(),
  .messages = .message_option()
)

Arguments

INPUT

raster - Input layer. Path to a raster layer.

BAND

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

Z_FACTOR

number - Z factor (vertical exaggeration). A numeric value.

SCALE

number - Scale (ratio of vertical units to horizontal). A numeric value.

AZIMUTH

number - Azimuth of the light. A numeric value.

ALTITUDE

number - Altitude of the light. A numeric value.

COMPUTE_EDGES

boolean - Compute edges. 1 for true/yes. 0 for false/no.

ZEVENBERGEN

boolean - Use Zevenbergen&Thorne formula instead of the Horn's one. 1 for true/yes. 0 for false/no.

COMBINED

boolean - Combined shading. 1 for true/yes. 0 for false/no.

MULTIDIRECTIONAL

boolean - Multidirectional shading. 1 for true/yes. 0 for false/no.

OPTIONS

string - Additional creation options. String value.

EXTRA

string - Additional command-line parameters. String value.

OUTPUT

rasterDestination - Hillshade. Path for new raster 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 - outputRaster - Hillshade


JanCaha/r_package_qgis documentation built on March 7, 2023, 7:17 a.m.