Skip to contents

Multiscale roughness

Source: R/terrain_analysis.R
wbt_multiscale_roughness.Rd

Calculates surface roughness over a range of spatial scales.

Usage

wbt_multiscale_roughness(
  dem,
  out_mag,
  out_scale,
  max_scale,
  min_scale = 1,
  step = 1,
  wd = NULL,
  verbose_mode = NULL,
  compress_rasters = NULL,
  command_only = FALSE
)

Arguments

dem

Input raster DEM file.

out_mag

Output raster roughness magnitude file.

out_scale

Output raster roughness scale file.

max_scale

Maximum search neighbourhood radius in grid cells.

min_scale

Minimum search neighbourhood radius in grid cells.

step

Step size as any positive non-zero integer.

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.