wbt_impoundment_size_index: Impoundment size index

In giswqs/whiteboxR: 'WhiteboxTools' R Frontend

Impoundment size index

Description

Calculates the impoundment size resulting from damming a DEM.

Usage

wbt_impoundment_size_index(
  dem,
  damlength,
  out_mean = NULL,
  out_max = NULL,
  out_volume = NULL,
  out_area = NULL,
  out_dam_height = NULL,
  wd = NULL,
  verbose_mode = NULL,
  compress_rasters = NULL,
  command_only = FALSE
)

Arguments

dem	Input raster DEM file.
damlength	Maximum length of the dam.
out_mean	Output mean flooded depth file.
out_max	Output maximum flooded depth file.
out_volume	Output flooded volume file.
out_area	Output flooded area file.
out_dam_height	Output dam height file.
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.