wbt_user_defined_weights_filter: User ined weights filter

View source: R/image_analysis_filters.R

wbt_user_defined_weights_filterR Documentation

User ined weights filter

Description

Performs a user-defined weights filter on an image.

Usage

wbt_user_defined_weights_filter(
  input,
  weights,
  output,
  center = "center",
  normalize = FALSE,
  wd = NULL,
  verbose_mode = NULL,
  compress_rasters = NULL,
  command_only = FALSE
)

Arguments

input

Input raster file path. See wbt_file_path() for details.

weights

Input weights file.

output

Output raster file.

center

Kernel center cell; options include 'center', 'upper-left', 'upper-right', 'lower-left', 'lower-right'.

normalize

Normalize kernel weights? This can reduce edge effects and lessen the impact of data gaps (nodata) but is not suited when the kernel weights sum to zero.

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.


whitebox documentation built on Nov. 19, 2023, 1:07 a.m.