whitebox (version 0.1.0)

fd8_flow_accumulation: Fd8 flow accumulation

Description

Calculates an FD8 flow accumulation raster from an input DEM.

Usage

fd8_flow_accumulation(dem, output,
  out_type = "specific contributing area", exponent = 1.1,
  threshold = NULL, log = FALSE, clip = FALSE,
  verbose_mode = 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 inifinity.

log

Optional flag to request the output be log-transformed.

clip

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

verbose_mode

Sets verbose mode. If verbose mode is False, tools will not print output messages.

Value

Returns the tool text outputs.