TidalCharacteristics: Calculate tidal characteristics

In Tides: Quasi-Periodic Time Series Characteristics

Description

Calculates the characteristics of observed tidal water levels. Wrapper of the functions extrema, IT and IF. Also works on time series with gaps.

Usage

TidalCharacteristics(h, h0 = h$h0, T2 = 5 * 60 * 60, hoffset = 0,
  filtconst = 1, dtMax = 15, unit = "mins", Tavg = 12.4 * 60,
  removegaps = c("All", "Split", "None"))

Arguments

h	Water level time series. data frame with time and h column
h0	Reference level, either single valued or vector with dimension corresponding to h
T2	'Lower' bound on half the quasi period, but higher than expected stagnant phase; default = 5h
hoffset	Offset level, to prevent spurious maxima generation due to small fluctuations
filtconst	Filtering constant for smoothing the time series
dtMax	Maximum accepted time interval in a continuous series. Bigger time intervals are considered to be gaps
unit	Unit of dtMax, Tavg
Tavg	Average period of time series
removegaps	Method to remove gaps in time series from inundation times and dry times. See RemoveGaps

Value

An object of class Tides, i.e. a list containing:

• HLData frame with extrema

• h original water level data frame with additional attributes

• gapsa data frame containing start and end times of gaps in the series

• IFinundation frequency of the reference level

• ITsinundation times at the reference level

• DTsdry times at the reference level

• h0reference level

• NTotal number of cycles in time span

Author(s)

Tom Cox <[e-mail]>, Lennert Schepers <[e-mail]>

See Also

extrema, IT, plot.Tides

Examples

TC <- TidalCharacteristics(waterlevels, filtconst=10,hoffset=1)
 TC
 plot(TC)
 summary(TC)

Example output

Warning message:
In gapsts(wet$time, dtMax, unit = unit, shiftbegin = TRUE) :
  First data point is beginning of gap. To shift t0, dt is estimated from next continuous series
Inundation frequency:  59.32203 
Inundations during time span:  34.5 
Average inundation height:  49.07143 
Average inundation height (per cycle):  49.78261 
Average inundation time:  299.3023 mins 
Average inundation time (per cycle):  373.0435 mins 
Maximal inundation time:  2075 mins 
Average dry time:  587.1875 mins 
Average dry time (per cycle):  816.9565 mins 
Maximal dry time:  10205 mins 
Average high water:  338.8743 
Average low water:  290.95 
Time span:  30.92014  days 
Observations in time span:  30.92014  days or  59  average tidal cycles 
Inundations in time span:  34 tidal cycles 
Fully observed inundated tidal cycles:  34  full tidal cycles 
There were no gaps in the time series 
$IFsum
[1] 59.32203

$nIndsum
numeric(0)

$IHsum
[1] 49.07143

$IHcsum
numeric(0)

$Tunitssum
[1] "mins"

$ITsum
Time difference of 299.3023 mins

$ITCsum
Time difference of  mins

$ITMsum
Time difference of 2075 mins

$DTsum
Time difference of 587.1875 mins

$DTCsum
Time difference of  mins

$DTMsum
Time difference of 10205 mins

$MHWsum
[1] 338.8743

$MLWsum
[1] 290.95

$TRsum
[1] 47.92429

$nTCsum
NULL

$nTCFsum
NULL

$nGsum
[1] 0

$GTsum
[1] 0

$nTSsum
[1] 1

$TTNoGapsum
Time difference of 41055 mins

$ITTsum
Time difference of 12870 mins

$DTTsum
Time difference of 28185 mins

$IPsum
[1] 0.3134819

$DPsum
[1] 0.6865181

Warning message:
In summary.Tides(TC) : There were no gaps in the time series

Tides documentation built on May 2, 2019, 2:03 a.m.