ocmw.core.tidal module

Functions for applying tidal analysis to timeseries of tidal flow parameters.

harmonicReduction	Apply harmonic reduction to a timeseries of data using tidal harmonic constitutents.
extractHarmValues	Extract the key harmonic parameters from the data structure returned by harmonicReducation.
saveTide	Save harmonic reduction parameters to a *.mat file.
signalDecomposition	Decompose a timeseries of data into tidal, non-tidal low frequency, and non-tidal high frequency components.
get_slack_water_times	Determine slack water times from a timeseries of tidal velocities.
get_tidal_range	Determine tidal range data from a timeseries of tidal surface elevations.
print_tide_times	Display tide times and tidal ranges based on output from get_tidal_range.

Functions for applying tidal analysis to timeseries of tidal flow parameters.

ocmw.core.tidal.harmonicReduction(param, dt, lat=55.8, constit='auto', meth='ols', ci='MC', fullOutput=False, verbose=False)

Apply harmonic reduction to a timeseries of data using tidal harmonic constitutents.

ocmw.core.tidal.extractHarmValues(coef)

Extract the key harmonic parameters from the data structure returned by harmonicReducation.

ocmw.core.tidal.saveTide(param, paramStr, dt, coef, outFile, descriptStr='')

Save harmonic reduction parameters to a *.mat file.

ocmw.core.tidal.signalDecomposition(dnum, val, lat=55.8, constit='auto', cutoff_period: float = 25.0)

Decompose a timeseries of data into tidal, non-tidal low frequency, and non-tidal high frequency components.

ocmw.core.tidal.get_slack_water_times(dnum, vmag)

Determine slack water times from a timeseries of tidal velocities.

ocmw.core.tidal.get_tidal_range(dnum, elev)

Determine tidal range data from a timeseries of tidal surface elevations.

ocmw.core.tidal.print_tide_times(lowTimes, highTimes, lowElev, highElev)

Display tide times and tidal ranges based on output from get_tidal_range.