processBursts: Generate wave statistics for multiple sampling bursts

Description Usage Arguments Value

View source: R/processBursts.R

Description

Generate wave statistics for multiple sampling bursts

Usage

1
processBursts(Ht, times, burstLength = NULL, Fs, method = "sp", tzone = NULL)

Arguments

Ht

A vector of sea surface heights

times

A vector of POSIXct time stamps

burstLength

The desired sampling burst length, in minutes

Fs

The sampling rate of the data, units of Hz (samples per second)

method

The wave statistic estimation method, either 'sp' for spectral (default) or 'zc' for zero-crossing

tzone

The time zone for input POSIXct time values. Default = 'UTC'

Value

A data frame of wave statistics (height and period) for each sampling burst. The time value represents the time stamp at the end of the sampling burst


millerlp/owhlR documentation built on April 6, 2020, 9:46 a.m.