whitebox (version 2.3.1)

wbt_depth_to_water: Depth to water

Description

This tool calculates cartographic depth-to-water (DTW) index.

Usage

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

Value

Returns the tool text outputs.

Arguments

dem

Name of the input raster DEM file.

output

Name of the output raster image file.

streams

Name of the input streams vector (optional).

lakes

Name of the input lakes vector (optional).

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.

command_only

Return command that would be executed by system() rather than running tool.