wbt_percentage_contrast_stretch: Percentage contrast stretch

View source: R/image_analysis_enhancement.R

wbt_percentage_contrast_stretchR Documentation

Percentage contrast stretch

Description

Performs a percentage linear contrast stretch on input images.

Usage

wbt_percentage_contrast_stretch(
  input,
  output,
  clip = 1,
  tail = "both",
  num_tones = 256,
  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.

clip

Optional amount to clip the distribution tails by, in percent.

tail

Specified which tails to clip; options include 'upper', 'lower', and 'both' (default is 'both').

num_tones

Number of tones in the output image.

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.


giswqs/whiteboxR documentation built on Feb. 13, 2024, 6:16 p.m.