wbt_d8_flow_accumulation: D8 flow accumulation

Description Usage Arguments Value

View source: R/hydro_analysis.R

Description

Calculates a D8 flow accumulation raster from an input DEM or flow pointer.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
wbt_d8_flow_accumulation(
  input,
  output,
  out_type = "cells",
  log = FALSE,
  clip = FALSE,
  pntr = FALSE,
  esri_pntr = FALSE,
  wd = NULL,
  verbose_mode = FALSE
)

Arguments

input

Input raster DEM or D8 pointer file.

output

Output raster file.

out_type

Output type; one of 'cells' (default), 'catchment area', and 'specific contributing area'.

log

Optional flag to request the output be log-transformed.

clip

Optional flag to request clipping the display max by 1 percent.

pntr

Is the input raster a D8 flow pointer rather than a DEM?.

esri_pntr

Input D8 pointer uses the ESRI style scheme.

wd

Changes the working directory.

verbose_mode

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

Value

Returns the tool text outputs.


whitebox documentation built on Sept. 7, 2020, 3 p.m.