wbt_local_hypsometric_analysis: Local hypsometric analysis
In giswqs/whiteboxR: 'WhiteboxTools' R Frontend

wbt_local_hypsometric_analysis

R Documentation

Local hypsometric analysis

Description

This tool calculates a local, neighbourhood-based hypsometric integral raster.

Usage

wbt_local_hypsometric_analysis(
  input,
  out_mag,
  out_scale,
  min_scale = 4,
  step = 1,
  num_steps = 10,
  step_nonlinearity = 1,
  wd = NULL,
  verbose_mode = NULL,
  compress_rasters = NULL,
  command_only = FALSE
)

Arguments

`input`	Name of the input raster DEM file.
`out_mag`	Name of the openness output raster file.
`out_scale`	Name of the openness output raster file.
`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. 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`.