wbt_distance_to_outlet: Distance to outlet

In whitebox: 'WhiteboxTools' R Frontend

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 = NULL,
  compress_rasters = NULL,
  command_only = 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. 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.

whitebox documentation built on May 29, 2024, 1:21 a.m.