Calculates the distance to the furthest upstream channel head for each stream cell.
Usage
wbt_farthest_channel_head(
d8_pntr,
streams,
output,
esri_pntr = FALSE,
zero_background = FALSE,
wd = NULL,
verbose_mode = NULL,
compress_rasters = NULL,
command_only = FALSE
)
Arguments
- d8_pntr
Input raster D8 pointer file.
- streams
Input raster streams file.
- output
Output raster file.
- esri_pntr
D8 pointer uses the ESRI style scheme.
- zero_background
Flag indicating whether a background value of zero should be used.
- 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
.