wbt_breach_depressions_least_cost

Breaches the depressions in a DEM using a least-cost pathway method.

HydrologicalAnalysis

An R frontend for the 'WhiteboxTools' library, which is an advanced geospatial data analysis platform developed by Prof. John Lindsay at the University of Guelph's Geomorphometry and Hydrogeomatics Research Group. 'WhiteboxTools' can be used to perform common geographical information systems (GIS) analysis operations, such as cost-distance analysis, distance buffering, and raster reclassification. Remote sensing and image processing tasks include image enhancement (e.g. panchromatic sharpening, contrast adjustments), image mosaicing, numerous filtering operations, simple classification (k-means), and common image transformations. 'WhiteboxTools' also contains advanced tooling for spatial hydrological analysis (e.g. flow-accumulation, watershed delineation, stream network analysis, sink removal), terrain analysis (e.g. common terrain indices such as slope, curvatures, wetness index, hillshading; hypsometric analysis; multi-scale topographic position analysis), and LiDAR data processing. Suggested citation: Lindsay (2016) <doi:10.1016/j.cageo.2016.07.003>.

Andrew Brown

whitebox

'WhiteboxTools' R Frontend

Qiusheng Wu

wbt_breach_depressions_least_cost function

<dl><dt>dem</dt>
<dd>Input raster DEM file.</dd>
<dt>output</dt>
<dd>Output raster file.</dd>
<dt>dist</dt>
<dd>Maximum search distance for breach paths in cells.</dd>
<dt>max_cost</dt>
<dd>Optional maximum breach cost (default is Inf).</dd>
<dt>min_dist</dt>
<dd>Optional flag indicating whether to minimize breach distances.</dd>
<dt>flat_increment</dt>
<dd>Optional elevation increment applied to flat areas.</dd>
<dt>fill</dt>
<dd>Optional flag indicating whether to fill any remaining unbreached depressions.</dd>
<dt>wd</dt>
<dd>Changes the working directory.</dd>
<dt>verbose_mode</dt>
<dd>Sets verbose mode. If verbose mode is <code>FALSE</code>, tools will not print output messages.</dd>
<dt>compress_rasters</dt>
<dd>Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.</dd>
<dt>command_only</dt>
<dd>Return command that would be executed by <code><a href="/link/system()?package=whitebox&version=2.3.1" data-mini-rdoc="whitebox::system()">system()</a></code> rather than running tool.</dd></dl>

Arguments

Breach depressions least cost — wbt_breach_depressions_least_cost

<dl>

<dt>dem</dt>
<dd>Input raster DEM file.</dd>


<dt>output</dt>
<dd>Output raster file.</dd>


<dt>dist</dt>
<dd>Maximum search distance for breach paths in cells.</dd>


<dt>max_cost</dt>
<dd>Optional maximum breach cost (default is Inf).</dd>


<dt>min_dist</dt>
<dd>Optional flag indicating whether to minimize breach distances.</dd>


<dt>flat_increment</dt>
<dd>Optional elevation increment applied to flat areas.</dd>


<dt>fill</dt>
<dd>Optional flag indicating whether to fill any remaining unbreached depressions.</dd>


<dt>wd</dt>
<dd>Changes the working directory.</dd>


<dt>verbose_mode</dt>
<dd>Sets verbose mode. If verbose mode is <code>FALSE</code>, tools will not print output messages.</dd>


<dt>compress_rasters</dt>
<dd>Sets the flag used by 'WhiteboxTools' to determine whether to use compression for output rasters.</dd>


<dt>command_only</dt>
<dd>Return command that would be executed by <code><a href='https://rdrr.io/r/base/system.html'>system()</a></code> rather than running tool.</dd>

</dl>

wbt_breach_depressions_least_cost: Breach depressions least cost

Description

Usage

Value

Arguments