Learn R Programming
whitebox (version 2.1.0)

wbt_extract_streams: Extract streams

Description

Extracts stream grid cells from a flow accumulation raster.

Usage

wbt_extract_streams(
  flow_accum,
  output,
  threshold,
  zero_background = FALSE,
  wd = NULL,
  verbose_mode = FALSE,
  compress_rasters = FALSE
)

Arguments

flow_accum

Input raster D8 flow accumulation file.

output

Output raster file.

threshold

Threshold in flow accumulation values for channelization.

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.