whitebox (version 2.4.0)

wbt_rescale_value_range: Rescale value range

Description

Performs a min-max contrast stretch on an input greytone image.

Usage

wbt_rescale_value_range(
  input,
  output,
  out_min_val,
  out_max_val,
  clip_min = NULL,
  clip_max = NULL,
  wd = NULL,
  verbose_mode = NULL,
  compress_rasters = NULL,
  command_only = FALSE
)

Value

Returns the tool text outputs.

Arguments

input

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

output

Output raster file.

out_min_val

New minimum value in output image.

out_max_val

New maximum value in output image.

clip_min

Optional lower tail clip value.

clip_max

Optional upper tail clip value.

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.