Learn R Programming
whitebox (version 2.1.0)

wbt_extract_valleys: Extract valleys

Description

Identifies potential valley bottom grid cells based on local topolography alone.

Usage

wbt_extract_valleys(
  dem,
  output,
  variant = "LQ",
  line_thin = TRUE,
  filter = 5,
  wd = NULL,
  verbose_mode = FALSE,
  compress_rasters = FALSE
)

Arguments

dem

Input raster DEM file.

output

Output raster file.

variant

Options include 'LQ' (lower quartile), 'JandR' (Johnston and Rosenfeld), and 'PandD' (Peucker and Douglas); default is 'LQ'.

line_thin

Optional flag indicating whether post-processing line-thinning should be performed.

filter

Optional argument (only used when variant='lq') providing the filter size, in grid cells, used for lq-filtering (default is 5).

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.