wbt_openness {whitebox}

Openness

Description

This tool calculates the topographic openness index from an input DEM.

Usage

wbt_openness(
  input,
  pos_output,
  neg_output,
  dist = 20,
  wd = NULL,
  verbose_mode = NULL,
  compress_rasters = NULL,
  command_only = FALSE
)

Arguments

input

Name of the input raster DEM file.

pos_output

Name of the positive openness output raster file.

neg_output

Name of the negative openness output raster file.

dist

Search distance, in grid cells.

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.