netsse.base.WaveSequence
========================

.. toctree::
   :hidden:

   /api/netsse/base/WaveSequence.set_params

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

   Bases: :py:obj:`SeaState`


   Initialises the wave sequence.

   :param wave: Sea surface elevation time-series [m]. By default ``None``.
   :type wave: array-like of shape (Nt,), optional
   :param time: Vector of time [s], by default ``None``.
   :type time: array-like of shape (Nt,), optional

   :param fs: Sampling frequency [Hz].

              .. note::
                  Consult :func:`netsse.base.SeaState.__init__` for information on the other
                  parameters.
   :type fs: float, default 10

   :raises ValueError: In case the input ``time`` and ``wave`` vectors do not have the same length.

   .. rubric:: Examples

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

Methods
-------

.. autoapisummary::

   netsse.base.WaveSequence.set_params