waveStatsSP: Calculate ocean wave parameters using spectral analysis...

Description Usage Arguments Details Value References See Also Examples

View source: R/waveStatsSP.R

Description

Calculate ocean wave parameters using spectral analysis methods

Usage

1
2
waveStatsSP(data, Fs, method = c("welchPSD", "spec.pgram"), plot = FALSE,
  kernel = NULL, segments = NULL, ...)

Arguments

data

A vector of surface heights that constitute a time series of observations. Typical units = meters.

Fs

Sampling frequency of the surface heights data. Units = Hz, i.e. samples per second.

method

A character string indicating which spectral analysis method should be used. Choose one of welchPSD (default) or spec.pgram.

plot

A logical value denoting whether to plot the spectrum. Defaults to FALSE.

kernel

An object of class tskernel that defines a smoother for use with spec.pgram method. If value is NULL, a default Daniell kernel with widths (9,9,9) is used.

segments

Numeric value indicating the number of windowing segments to use with welchPSD method.

...

Additional arguments to be passed to spectral analysis functions, such as the windowfun option for welchPSD.

Details

Carries out spectral analysis of ocean wave height time series to estimate common wave height statistics, including peak period, average period, and significant wave height.

Value

List of wave parameters based on spectral methods.

References

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

See Also

waveStatsZC for wave statistics determined using a zero-crossing algorithm.

Examples

1
2
data(wavedata)
waveStatsSP(wavedata$SurfaceHeight.m, Fs = 4, method = 'spec.pgram', plot = TRUE)

millerlp/oceanwaves documentation built on Dec. 4, 2018, 4:22 a.m.