wbt_fill_depressions: Fill depressions

View source: R/hydro_analysis.R

wbt_fill_depressionsR Documentation

Fill depressions

Description

Fills all of the depressions in a DEM. Depression breaching should be preferred in most cases.

Usage

wbt_fill_depressions(
  dem,
  output,
  fix_flats = TRUE,
  flat_increment = NULL,
  max_depth = NULL,
  wd = NULL,
  verbose_mode = NULL,
  compress_rasters = NULL,
  command_only = FALSE
)

Arguments

dem

Input raster DEM file.

output

Output raster file.

fix_flats

Optional flag indicating whether flat areas should have a small gradient applied.

flat_increment

Optional elevation increment applied to flat areas.

max_depth

Optional maximum depression depth to fill.

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.


giswqs/whiteboxR documentation built on Feb. 13, 2024, 6:16 p.m.