Learn R Programming
whitebox (version 2.1.0)

wbt_quinn_flow_accumulation: Quinn flow accumulation

Description

This tool calculates Quinn et al. (1995) flow accumulation.

Usage

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

Arguments

dem

Name of the input DEM raster file; must be depressionless.

output

Name of the output raster file.

out_type

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

exponent

Optional exponent parameter; default is 1.0.

threshold

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

log

Log-transform the output values?.

clip

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

wd

Changes the working directory.

verbose_mode

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

compress_rasters

Sets the flag used by WhiteboxTools to determine whether to use compression for output rasters.

Value

Returns the tool text outputs.