Skip to contents

Weighted sum

Source: R/gis_analysis_overlay.R
wbt_weighted_sum.Rd

Performs a weighted-sum overlay on multiple input raster images.

Usage

wbt_weighted_sum(
  inputs,
  weights,
  output,
  wd = NULL,
  verbose_mode = NULL,
  compress_rasters = NULL,
  command_only = FALSE
)

Arguments

inputs

Input raster file paths, concatenated with "," or ";". See wbt_file_path() for details.

weights

Weight values, contained in quotes and separated by commas or semicolons.

output

Output raster file.

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.