Wave spectra

This function estimated the 1D wave spectrum (Power Spectral Density) and plot it

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

period (s) min and max for plotting: list

X axis limit in seconds

xaxis: str

Can be period or frequency depending what on the type of plot

display: str

On or Off to display image

folder out: str

Path to save the output

Examples:

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