wbt_relative_aspect: Relative aspect

View source: R/terrain_analysis.R

wbt_relative_aspectR Documentation

Relative aspect

Description

Calculates relative aspect (relative to a user-specified direction) from an input DEM.

Usage

wbt_relative_aspect(
  dem,
  output,
  azimuth = 0,
  zfactor = NULL,
  wd = NULL,
  verbose_mode = NULL,
  compress_rasters = NULL,
  command_only = FALSE
)

Arguments

dem

Input raster DEM file.

output

Output raster file.

azimuth

Illumination source azimuth.

zfactor

Optional multiplier for when the vertical and horizontal units are not the same.

wd

Changes the working directory. Default: NULL will use the value in WhiteboxTools settings, see wbt_wd() for details.

verbose_mode

Sets verbose mode. If verbose mode is FALSE, tools will not print output messages. Default: NULL will use the value in WhiteboxTools settings, see wbt_verbose() for details.

compress_rasters

Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters. Default: NULL will use the value in WhiteboxTools settings, see wbt_compress_rasters() for details.

command_only

Return command that would be executed by system() rather than running tool. Default: FALSE.

Value

Returns the tool text outputs.


whitebox documentation built on May 29, 2024, 1:21 a.m.