wbt_tophat_transform: Tophat transform

In giswqs/whiteboxR: 'WhiteboxTools' R Frontend

Tophat transform

Description

Performs either a white or black top-hat transform on an input image.

Usage

wbt_tophat_transform(
  input,
  output,
  filterx = 11,
  filtery = 11,
  variant = "white",
  wd = NULL,
  verbose_mode = NULL,
  compress_rasters = NULL,
  command_only = FALSE
)

Arguments

input	Input raster file path. See wbt_file_path() for details.
output	Output raster file.
filterx	Size of the filter kernel in the x-direction.
filtery	Size of the filter kernel in the y-direction.
variant	Optional variant value. Options include 'white' and 'black'.
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.

giswqs/whiteboxR documentation built on Oct. 14, 2024, 2:38 a.m.