Learn R Programming
whitebox (version 2.1.0)

wbt_distance_to_outlet: Distance to outlet

Description

Calculates the distance of stream grid cells to the channel network outlet cell.

Usage

wbt_distance_to_outlet(
  d8_pntr,
  streams,
  output,
  esri_pntr = FALSE,
  zero_background = FALSE,
  wd = NULL,
  verbose_mode = FALSE,
  compress_rasters = FALSE
)

Arguments

d8_pntr

Input raster D8 pointer file.

streams

Input raster streams file.

output

Output raster file.

esri_pntr

D8 pointer uses the ESRI style scheme.

zero_background

Flag indicating whether a background value of zero should be used.

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.