wbt_breakline_mapping: Breakline mapping

View source: R/terrain_analysis.R

wbt_breakline_mappingR Documentation

Breakline mapping

Description

This tool maps breaklines from an input DEM.

Usage

wbt_breakline_mapping(
  dem,
  output,
  threshold = 2,
  min_length = 3,
  wd = NULL,
  verbose_mode = FALSE,
  compress_rasters = FALSE,
  command_only = FALSE
)

Arguments

dem

Name of the input raster image file.

output

Name of the output vector lines file.

threshold

Threshold value (0 - infinity but typcially 1 to 5 works well).

min_length

Minimum line length, in grid cells.

wd

Changes the working directory.

verbose_mode

Sets verbose mode. If verbose mode is FALSE, tools will not print output messages.

compress_rasters

Sets the flag used by WhiteboxTools to determine whether to use compression for output rasters.

command_only

Return command that would be executed by system() rather than running tool.

Value

Returns the tool text outputs.


whitebox documentation built on Oct. 29, 2022, 1:10 a.m.