toto.plugins.tide.detide

class toto.plugins.tide.detide.TideAnalysis(pandas_obj)

Bases: object

detide(mag='mag', args={'folder out': '/home/docs/checkouts/readthedocs.org/user_builds/totodoc/checkouts/latest/docs', 'latitude': -36.0, 'minimum SNR': 2})

This function detide a timeseries using Utide software. Usefull if NaNs are in the timeseries

Parameters

magstr

Name of the column from which to extract the tide

args: dict

Dictionnary with the folowing keys:

minimum SNR: int folder out: str

Path to save the output

latitude: float

Examples:

>>> df=tf['test1']['dataframe'].TideAnalysis.detide(mag='U',args={'latitude':-36.5})
>>>

predict(mag='mag', args={'dt(s)': 60, 'latitude': -36.0, 'maximum time': <class 'datetime.datetime'>, 'minimum SNR': 2, 'minimum time': <class 'datetime.datetime'>, 'trend': False})

This function predict the tide by first detiding a timeseries. Works if NaN are in the timeseries

Parameters

magstr

Name of the column from which to extract the tide

args: dict

Dictionnary with the folowing keys:

minimum SNR: int folder out: str

Path to save the output

latitude: float minimum time: datetime

Time the time series start

maximum time: datetime

Time the time series end

dt(s): int

Time interval in seconds

Examples:

>>> df=tf['test1']['dataframe'].TideAnalysis.predict(mag='U',args={'latitude':-36.5,            'minimum time':datetime.datetime(2002,1,1),'maximum time':datetime.datetime(2003,1,1),            'dt(s)':3600)
>>>

skew_surge(mag='mag', args={'latitude': -36.0, 'minimum SNR': 2, 'tide_dt': 900})

This function calculate the skew surge : see https://www.ntslf.org/storm-surges/skew-surges

Parameters

magstr

Name of the column from which to extract the tide.

args: dict

Dictionnary with the parameters to use to fit the tides if required:

minimum SNR: int latitude: float tide_dt: int

Time delta to use to reconstruct the astronomical tides in seconds. Default is 15 minutes.

constituents: object

Tidal constituents to use to estimate the astronomical tides. Get calculated if not supplied.

Examples:

>>> df=tf['test1']['dataframe'].TideAnalysis.skew_surge(mag='U',args={'latitude':-36.5})
>>>

tidal_stat(mag='mag', args={'folder out': '/home/docs/checkouts/readthedocs.org/user_builds/totodoc/checkouts/latest/docs', 'latitude': -36.0, 'minimum SNR': 2})

Function to extract the tide stats from a time series

i.e HAT,LAT,MHWS,MLWS…

Parameters

magstr

Name of the column from which to extract the tide

args: dict

Dictionnary with the folowing keys:

minimum SNR: int folder out: str

Path to save the output

latitude: float

Examples:

>>> df=tf['test1']['dataframe'].TideAnalysis.tidal_stat(mag='U',args={'latitude':-36.5})
>>>