Calculates the perimeters of polygons or classes within a raster image.
Usage
wbt_raster_perimeter(
input,
output = NULL,
out_text = FALSE,
units = "grid cells",
zero_back = FALSE,
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.
- 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. Default:
NULL
will use the value in WhiteboxTools settings, seewbt_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, seewbt_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, seewbt_compress_rasters()
for details.- command_only
Return command that would be executed by
system()
rather than running tool. Default:FALSE
.