wbt_low_points_on_headwater_divides: Low points on headwater divides

View source: R/hydro_analysis.R

wbt_low_points_on_headwater_dividesR Documentation

Low points on headwater divides

Description

This tool locates saddle points along ridges within a digital elevation model (DEM).

Usage

wbt_low_points_on_headwater_divides(
  dem,
  streams,
  output,
  wd = NULL,
  verbose_mode = NULL,
  compress_rasters = NULL,
  command_only = FALSE
)

Arguments

dem

Name of the input DEM raster file.

streams

Name of the input stream channel raster file.

output

Name of the output vector file.

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 Nov. 19, 2023, 1:07 a.m.