Surface elevation to wave

This function transform a timeseries of elevation to Hs using: -Spectra method - zero-crossing method

Parameters

sea_levelstr

Name of the column which contains the sea level.

args: dict

Dictionnary with the folowing keys: units: str

Units of the sea level

windows: int

windows to process in seconds.

overlap: int

overlap in seconds

nfft: int

Length of the signal to calculate the Fourier transform of.

detrend: str

linear, constante or Off to detrend the timeseries before doing the analysis

wave period range (min and max) (in s): list

Calulating wave within this Wave period

method: str

Can be spectra or zero-crossing depending what method to use

minimum number of waves per window for zero crossing analysis: int

Minimum number of waves per window for zero crossing analysis

crossing: str

Can be downcrossing or upcrossing. Method to use if not using the spectra method

Examples:

>>> df=tf['test1']['dataframe'].WaveAnalysis.ssh_to_wave(sea_level='ssh',args={'method'='spectra',windows:3600,'nfft':3600,'overlap':3600)
>>>