wbt_impoundment_size_index {whitebox}R Documentation

Impoundment size index

Description

Calculates the impoundment size resulting from damming a DEM.

Usage

wbt_impoundment_size_index(
  dem,
  output,
  damlength,
  out_type = "mean depth",
  wd = NULL,
  verbose_mode = FALSE
)

Arguments

dem

Input raster DEM file.

output

Output file.

damlength

Maximum length of the dam.

out_type

Output type; one of 'mean depth' (default), 'volume', 'area', 'max depth'.

wd

Changes the working directory.

verbose_mode

Sets verbose mode. If verbose mode is False, tools will not print output messages.

Value

Returns the tool text outputs.


[Package whitebox version 1.4.0 Index]