Learn R Programming
whitebox (version 2.1.0)

wbt_rho8_flow_accumulation: Rho8 flow accumulation

Description

This tool calculates Fairfield and Leymarie (1991) flow accumulation.

Usage

wbt_rho8_flow_accumulation(
  input,
  output,
  out_type = "specific contributing area",
  log = FALSE,
  clip = FALSE,
  pntr = FALSE,
  esri_pntr = FALSE,
  wd = NULL,
  verbose_mode = FALSE,
  compress_rasters = FALSE
)

Arguments

input

Input DEM or Rho8 pointer file; if a DEM is used, it must be depressionless.

output

Name of the output raster file.

out_type

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

log

Log-transform the output values?.

clip

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

pntr

Is the input raster a Rho8 flow pointer rather than a DEM?.

esri_pntr

Does the input Rho8 pointer use the ESRI style scheme?.

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.