whitebox (version 2.4.0)

wbt_create_colour_composite: Create colour composite

Description

Creates a colour-composite image from three bands of multispectral imagery.

Usage

wbt_create_colour_composite(
  red,
  green,
  blue,
  output,
  opacity = NULL,
  enhance = TRUE,
  zeros = FALSE,
  wd = NULL,
  verbose_mode = NULL,
  compress_rasters = NULL,
  command_only = FALSE
)

Value

Returns the tool text outputs.

Arguments

red

Input red band image file.

green

Input green band image file.

blue

Input blue band image file.

output

Output colour composite file.

opacity

Input opacity band image file (optional).

enhance

Optional flag indicating whether a balance contrast enhancement is performed.

zeros

Optional flag to indicate if zeros are nodata values.

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.