Description Usage Arguments Details Examples
Compute cumulative cross section change by region directy from cross section data.
1 2 3 4 5 6 | xs_region_cumulative_change(d, time.col = "Time", station.col = "Station",
distance.col = "Distance", elevation.col = "Elevation", bank.stations,
extent.stations = NULL, reference.elevation = NULL,
bottom.elevation = NULL, region = c("LOB", "Channel", "ROB"),
station.lengths = NULL, over.time = TRUE, longitudinal = TRUE,
direction = "downstream")
|
d |
The cross section data, i.e. output of |
time.col |
The column containing time stamps. |
station.col |
The column containing cross section station IDs. |
distance.col |
The column containing cross section distances. |
elevation.col |
The column containing cross section elevations. |
bank.stations |
A table defining the bank station distances to use when
computing cross section area. If |
extent.stations |
The maximum extents of each station. Expects a three-column table with column names "Station", "LE" and "RE, where "LE" and "RE" define the left extent and right extent of each station, respectively. Can also accept a two-element numeric vector specifying constant left and right edges. If NULL, the minimum and maximum coincident distances of each cross section will be used. |
reference.elevation |
Use predefined reference elevations when computing
cross section area. Can be a constant or a two column station of cross
section labels and associated reference elevation. If |
bottom.elevation |
Use predefined bottom elevations when computing
cross section area. Can be a constant or a two column station of cross
section labels and associated bottom elevation. If |
region |
The region(s) to compute area for. Can be any combination of "channel", "LOB", "ROB". See details for more information. |
station.lengths |
The cross section length values. |
over.time |
If |
longitudinal |
If |
direction |
Accumulate data in the downstream (descending order of cross
section IDs) or upstream (ascending order) direction. Ignored if
|
This is essentially a wrapper for processing cross section data
through the sequence xs_regions
–> region_to_volume
–>
change_sediment
–> cumulative_sediment
.
1 2 3 4 5 6 7 8 9 10 | simple.quasi = system.file("sample-data/SampleQuasiUnsteady.hdf",
package = "RAStestR")
quasi.xs = read_xs(simple.quasi)
quasi.banks = read_bank_stations(simple.quasi)
quasi.extents = xs_extents(quasi.xs)
quasi.lengths = xs_lengths(read_station_lengths(simple.quasi))
xs_region_cumulative_change(quasi.xs, bank.stations = quasi.banks,
extent.stations = quasi.extents, station.lengths = quasi.lengths)
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.