Wavelet analysis

This function estimates the wavelet power spectrum of a time series, as well as the scaled-averaged wavelet power time series within a specific period band. The code is based on the wavelet toolbox from Torrence and Compo See https://paos.colorado.edu/research/wavelets/software.html

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

mother wavelet: str

Can be Morlet,`Paul` or DOG

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

Calulating wave within this Wave period

number of sub-ocatve per period band: int

Number of sub-ocatve per period band

display: str

On or Off to display image

folder out: str

Path to save the output

Examples:

>>> df=tf['test1']['dataframe'].WaveAnalysis.wavelet_analysis(sea_level='ssh',args={})
>>>