wbt_fd8_flow_accumulation {whitebox}

Fd8 flow accumulation

Description

Calculates an FD8 flow accumulation raster from an input DEM.

Usage

wbt_fd8_flow_accumulation(
  dem,
  output,
  out_type = "specific contributing area",
  exponent = 1.1,
  threshold = NULL,
  log = FALSE,
  clip = FALSE,
  wd = NULL,
  verbose_mode = NULL,
  compress_rasters = NULL,
  command_only = FALSE
)

Arguments

dem

Input raster DEM file.

output

Output raster file.

out_type

Output type; one of 'cells', 'specific contributing area' (default), and 'catchment area'.

exponent

Optional exponent parameter; default is 1.1.

threshold

Optional convergence threshold parameter, in grid cells; default is infinity.

log

Optional flag to request the output be log-transformed.

clip

Optional flag to request clipping the display max by 1 percent.

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.