whitebox (version 2.4.0)

wbt_river_centerlines: River centerlines

Description

Maps river centerlines from an input water raster.

Usage

wbt_river_centerlines(
  input,
  output,
  min_length = 3,
  radius = 4,
  wd = NULL,
  verbose_mode = NULL,
  compress_rasters = NULL,
  command_only = FALSE
)

Value

Returns the tool text outputs.

Arguments

input

Name of the input raster image file.

output

Name of the output vector lines file.

min_length

Minimum line length, in grid cells.

radius

Search radius for joining distant endnodes, in grid cells.

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.