Sobel filter — wbt_sobel_filter • whitebox

Performs a Sobel edge-detection filter on an image.

Usage

wbt_sobel_filter(
  input,
  output,
  variant = "3x3",
  clip = 0,
  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.
variant: Optional variant value. Options include 3x3 and 5x5 (default is 3x3).
clip: Optional amount to clip the distribution tails by, in percent (default is 0.0).
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.