CM.plotWidth: Plot channel width

Description Usage Arguments Details Value Author(s) Examples

View source: R/CM.plotWidth.r

Description

Plot the channel width of the whole channel (default) or for a portion (use cl argument). The function can also compare two data sets if they have the same reference centerline.

Usage

1
CM.plotWidth(cmgo.obj, set = "set1", set.compare = NULL, cl = NULL, d = NULL)

Arguments

cmgo.obj

the global object of type list containing data and parameters created with CM.ini()

set

the primary data set to plot ("set1" by default)

set.compare

the secondary data set to plot (optional)

cl

the range of centerline points to be plotted, if NULL (default) the full channel length will be plotted, if a vector of two elements is provided (e.g. c(200, 500)) this cl range is plotted, if a string is provided (e.g. "cl1"), the range defined in par$plot.cl.ranges$cl1 will be plotted

d

the distance range of the centerline downstream to be plotted, NULL (default) cl defintions are taken, if a single value (e.g. d=500) is given 50m around this distance is plotted, if a vector with two elements is given (e.g. c(280, 620)) this distance range will be plotted

Details

If more than one data set is defined in the global data object, of

Details

Value

desc

Author(s)

Antonius Golly

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
# open demo
cmgo.obj = CM.ini("demo2")

# example 1: plot channel width of whole channel
CM.plotWidth(cmgo.obj)

# example 2: plot channel width of a defined range (centerline points)
CM.plotWidth(cmgo.obj, cl=c(800, 1000))

# example 2: plot channel width of a defined range (distance downstream)
CM.plotWidth(cmgo.obj, d=c(200, 600))

AntoniusGolly/cmgo documentation built on April 16, 2021, 2:52 p.m.