wbt_stochastic_depression_analysis: Stochastic depression analysis

View source: R/hydro_analysis.R

wbt_stochastic_depression_analysisR Documentation

Stochastic depression analysis

Description

Performs a stochastic analysis of depressions within a DEM.

Usage

wbt_stochastic_depression_analysis(
  dem,
  output,
  rmse,
  range,
  iterations = 100,
  wd = NULL,
  verbose_mode = NULL,
  compress_rasters = NULL,
  command_only = FALSE
)

Arguments

dem

Input raster DEM file.

output

Output file.

rmse

The DEM's root-mean-square-error (RMSE), in z units. This determines error magnitude.

range

The error field's correlation length, in xy-units.

iterations

The number of iterations.

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 Oct. 14, 2024, 2:38 a.m.