constants

  • Routines for estimating the harmonic constants for ocean tides

Calling Sequence

import pyTMD.solve
amp, phase = pyTMD.solve.constants(time, h, con)

Source code

pyTMD.solve.constants(t: float | numpy.ndarray, ht: ndarray, constituents: str | list | numpy.ndarray, deltat: float | numpy.ndarray = 0.0, corrections: str = 'OTIS', solver: str = 'lstsq')[source]

Estimate the harmonic constants for an elevation time series [1]

Parameters
t: float or np.ndarray

days relative to 1992-01-01T00:00:00

ht: np.ndarray

elevation time series (meters)

constituents: str, list or np.ndarray

tidal constituent ID(s)

deltat: float or np.ndarray, default 0.0

time correction for converting to Ephemeris Time (days)

corrections: str, default ‘OTIS’

use nodal corrections from OTIS/ATLAS or GOT/FES models

solver: str, default ‘lstsq’

least squares solver to use

  • 'lstsq': least squares solution

  • 'gelsy': complete orthogonal factorization

  • 'gelss': singular value decomposition (SVD)

  • 'gelsd': SVD with divide and conquer method

Returns
amp: np.ndarray

amplitude of each harmonic constant (meters)

phase: np.ndarray

phase of each harmonic constant (degrees)

References

1

G. D. Egbert and S. Y. Erofeeva, “Efficient Inverse Modeling of Barotropic Ocean Tides,” Journal of Atmospheric and Oceanic Technology, 19(2), 183–204, (2002). doi: 10.1175/1520-0426(2002)019<0183:EIMOBO>2.0.CO;2