TidalCharacteristics: Calculate tidal characteristics

In Tides: Tides

Description

Calculates the characteristics of observed tidal water levels. Wrapper of the functions extrema, IT and IF

Usage

TidalCharacteristics(h,h0 = h$h0,T2 = 5*60*60, hoffset = 3, filtconst = 1, dtMax = 15,unit = "mins", Tavg = 12.4*60 ) 
TC <- TidalCharacteristics(h,...)

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

Value

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

HL	Data frame with extrema
h	original water level data frame with additional attributes
gaps	a data frame containing start and end times of gaps in the series
IF	inundation frequency of the reference level
ITs	inundation times at the reference level
DTs	dry times at the reference level
h0	reference level
N	Total number of cycles in time span

Author(s)

Tom Cox <[e-mail]>

See Also

extrema, IT, plot.Tides

Examples

TC <- TidalCharacteristics(waterlevels)
TC
plot(TC)

Example output

Warning message:
In gapsts(dry$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:  77.9661 
Inundations during time span:  45.5 
Average inundation height:  37.5413 
Average inundation height (per cycle):  37.95385 
Average inundation time:  328.8298 mins 
Average inundation time (per cycle):  339.6703 mins 
Maximal inundation time:  2085 mins 
Average dry time:  456.3208 mins 
Average dry time (per cycle):  531.5385 mins 
Maximal dry time:  10185 mins 
Average high water:  327.4152 
Average low water:  290.8574 
Time span:  30.95139  days 
Observations in time span:  30.95139  days or  59  average tidal cycles 
Inundations in time span:  45 tidal cycles 
Fully observed inundated tidal cycles:  45  full tidal cycles 
There were no gaps in the time series 

Tides documentation built on May 2, 2019, 4:46 p.m.