netsse.base.WaveSequence

class netsse.base.WaveSequence(Hs=0, Tp=0, timestamp=datetime.now(), lat=0, lon=0, depth=0, wave=None, time=None, fs=10)

Bases: SeaState

Initialises the wave sequence.

Parameters:

• wave (array-like of shape (Nt,), optional) – Sea surface elevation time-series [m]. By default None.

• time (array-like of shape (Nt,), optional) – Vector of time [s], by default None.

• fs (float, default 10) –

  Sampling frequency [Hz].

  Note

  Consult netsse.base.SeaState.__init__() for information on the other parameters.

Raises:

ValueError – In case the input time and wave vectors do not have the same length.

Examples

>>> waveseq =
...     WaveSequence(Hs, Tp, timestamp, lat, lon, depth, wave, time)

Methods

set_params(Hs, Tp)

Sets the sea state parameters \(H_s\) and \(T_p\) to new