wbt_impoundment_size_index: Impoundment size index

Description Usage Arguments Value

View source: R/hydro_analysis.R

Description

Calculates the impoundment size resulting from damming a DEM.

Usage

1
2
3
4
5
6
7
8
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.


whitebox documentation built on Sept. 7, 2020, 3 p.m.