Downslope flowpath length — wbt_downslope_flowpath

Calculates the downslope flowpath length from each cell to basin outlet.

Usage

wbt_downslope_flowpath_length(
  d8_pntr,
  output,
  watersheds = NULL,
  weights = NULL,
  esri_pntr = FALSE,
  wd = NULL,
  verbose_mode = NULL,
  compress_rasters = NULL,
  command_only = FALSE
)

Arguments

d8_pntr: Input D8 pointer raster file.
output: Output raster file.
watersheds: Optional input watershed raster file.
weights: Optional input weights raster file.
esri_pntr: D8 pointer uses the ESRI style scheme.
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.