waveStatsZC: Calculate wave statistics using zero-crossing method

Description Usage Arguments Details Value References See Also Examples

View source: R/waveStatsZC.R

Description

Calculate ocean wave summary statistics, including significant wave height and period.

Usage

1
waveStatsZC(data, Fs, threshold = NULL, plot = FALSE)

Arguments

data

A numeric vector of water surface height data. The data do not need to be detrended prior to use. Typical units = meters

Fs

Sampling frequency of the data, in Hz.

threshold

The minimum height necessary for a zero-crossing event to be considered a wave.

plot

Set to TRUE if summary histograms of wave heights and wave periods are desired.

Details

Based on an upward zero-crossing algorithm originally provided by Urs Neumeier, v1.06. However, by default the algorithm is run as a downward zero-crossing process by inverting the data.

Value

A list object containing summary statistic values.

References

Original MATLAB function by Urs Neumeier: http://neumeier.perso.ch/matlab/waves.html

See Also

waveStatsSP for wave statistics determined using spectral analysis methods.

Examples

1
2
data(wavedata)
waveStatsZC(data = wavedata$swDepth.m, Fs = 4, plot = TRUE)

Example output

Loading required package: ggplot2
$Hsig
[1] 0.3870003

$Hmean
[1] 0.2530191

$H10
[1] 0.4686878

$Hmax
[1] 0.565325

$Tmean
[1] 9.622973

$Tsig
[1] 11.81855

oceanwaves documentation built on June 2, 2021, 9:08 a.m.