impoundment_index {whitebox}R Documentation

Impoundment index

Description

Calculates the impoundment size resulting from damming a DEM.

Usage

impoundment_index(dem, output, damlength, out_type = "depth",
  verbose_mode = FALSE)

Arguments

dem

Input raster DEM file.

output

Output file.

damlength

Maximum length of thr dam.

out_type

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

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]