whitebox (version 2.3.1)

wbt_multiscale_elevation_percentile: Multiscale elevation percentile

Description

Calculates surface roughness over a range of spatial scales.

Usage

wbt_multiscale_elevation_percentile(
  dem,
  out_mag,
  out_scale,
  sig_digits = 3,
  min_scale = 4,
  step = 1,
  num_steps = 10,
  step_nonlinearity = 1,
  wd = NULL,
  verbose_mode = FALSE,
  compress_rasters = FALSE,
  command_only = FALSE
)

Value

Returns the tool text outputs.

Arguments

dem

Input raster DEM file.

out_mag

Output raster roughness magnitude file.

out_scale

Output raster roughness scale file.

sig_digits

Number of significant digits.

min_scale

Minimum search neighbourhood radius in grid cells.

step

Step size as any positive non-zero integer.

num_steps

Number of steps.

step_nonlinearity

Step nonlinearity factor (1.0-2.0 is typical).

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.