coef.tide {TideHarmonics}

Coefficients For Tidal Object

Description

Give coefficients and harmonic constituents of a tidal object.

Usage

## S3 method for class 'tide'
coef(object, hc = FALSE, mat = hc, utc = 0, ...)

Arguments

object

An object of class 'tide'.

hc

If TRUE, returns harmonic constituent values, in order of decreasing amplitude. If mat is FALSE, a vector is returned containing the amplitudes and then the phase lags. If mat is TRUE, a four column matrix is returned, with the amplitudes, phase lags, sine coefficients and cosine coefficients in the columns.

mat

If TRUE, a matrix is returned.

utc

The phase lags are given in UTC plus or minus utc hours. For example, if Australian Eastern Standard Time is required, use positive 10. If Pacific Standard Time is required, use negative 8.

...

Not used.

Value

A numeric vector or numeric matrix of sine and cosine coefficients, or of amplitudes and phase lags. The phase lags are with respect to the time zone specified by the utc argument, which is UTC by default.

See Also

ftide, predict.tide

Examples

hfit1 <- ftide(Hillarys$SeaLevel, Hillarys$DateTime, hc60)
hfit2 <- ftide(Hillarys$Sea, Hillarys$Date, hc7, smsl=TRUE)
coef(hfit1, hc = TRUE)
coef(hfit2)
coef(hfit2, mat = TRUE)
coef(hfit2, hc = TRUE)
coef(hfit2, hc = TRUE, mat = FALSE)