draw_simple_OCN: Draw an Optimal Channel Network

View source: R/draw_simple_OCN.R

draw_simple_OCNR Documentation

Draw an Optimal Channel Network

Description

Function that plots the non-aggregated OCN as calculated by create_OCN.

Usage

draw_simple_OCN(OCN, thrADraw = 0.002 * OCN$FD$nNodes *
  OCN$cellsize^2, riverColor = "#0066FF", easyDraw = NULL, 
  min_lwd = 0.5,  max_lwd = 5)

Arguments

OCN

A river object as produced by create_OCN.

thrADraw

Threshold drainage area value used to display the network.

riverColor

Color used to plot the river.

easyDraw

Logical. If TRUE, the whole network is displayed, and pixels with drainage area lower than thrADraw are displayed in light gray. If FALSE, only pixels with drainage area greater or equal to thrADraw are displayed. Default is FALSE if OCN$nNodes <= 40000, and TRUE otherwise. Note that setting easyDraw = FALSE for large networks might slow down the process considerably.

min_lwd, max_lwd

Minimum and maximum values of line width used to display the OCN (actual line width is proportional to the square root of drainage area).

Value

No output is returned.

Examples

# 1a) draw OCN with default settings
draw_simple_OCN(OCN_250_T)

# 1b) same as above, but with decreased thrADraw
draw_simple_OCN(OCN_250_T, thrADraw = 0.001 * OCN_250_T$dimX * OCN_250_T$dimY)
# 1c) same as the first example, but include the portion of network  
# with drainage area lower than thrADraw 
draw_simple_OCN(OCN_250_T, easyDraw = FALSE) # this will take some seconds


OCNet documentation built on Nov. 24, 2023, 1:06 a.m.