wbt_d_inf_flow_accumulation: D inf flow accumulation

In giswqs/whiteboxR: 'WhiteboxTools' R Frontend

D inf flow accumulation

Description

Calculates a D-infinity flow accumulation raster from an input DEM.

Usage

wbt_d_inf_flow_accumulation(
  input,
  output,
  out_type = "Specific Contributing Area",
  threshold = NULL,
  log = FALSE,
  clip = FALSE,
  pntr = FALSE,
  wd = NULL,
  verbose_mode = NULL,
  compress_rasters = NULL,
  command_only = FALSE
)

Arguments

input	Input raster DEM or D-infinity pointer file.
output	Output raster file.
out_type	Output type; one of 'cells', 'sca' (default), and 'ca'.
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.
pntr	Is the input raster a D-infinity flow pointer rather than a DEM?.
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.

giswqs/whiteboxR documentation built on Oct. 14, 2024, 2:38 a.m.