whitebox (version 2.1.0)

wbt_raster_area: Raster area

Description

Calculates the area of polygons or classes within a raster image.

Usage

wbt_raster_area(
  input,
  output = NULL,
  out_text = FALSE,
  units = "grid cells",
  zero_back = FALSE,
  wd = NULL,
  verbose_mode = FALSE,
  compress_rasters = FALSE
)

Arguments

input

Input raster file.

output

Output raster file.

out_text

Would you like to output polygon areas to text?.

units

Area units; options include 'grid cells' and 'map units'.

zero_back

Flag indicating whether zero values should be treated as a background.

wd

Changes the working directory.

verbose_mode

Sets verbose mode. If verbose mode is False, tools will not print output messages.

compress_rasters

Sets the flag used by WhiteboxTools to determine whether to use compression for output rasters.

Value

Returns the tool text outputs.