ellipse

Expresses the amplitudes and phases for the u and v components in terms of four ellipse parameters using Foreman’s formula [20]

Calling Sequence

import pyTMD
umajor,uminor,uincl,uphase = pyTMD.ellipse.ellipse(u,v)

pyTMD.ellipse.ellipse(u: ndarray, v: ndarray)[source]

Expresses the amplitudes and phases for the u and v components in terms of four ellipse parameters using Foreman’s formula [20]

Parameters:

Returns:

major: np.ndarray: amplitude of the semi-major axis
minor: np.ndarray: amplitude of the semi-minor axis
incl: np.ndarray: angle of inclination of the northern semi-major axis
phase: np.ndarray: phase lag of the maximum current behind the maximum tidal potential

pyTMD.ellipse.inverse(major: ndarray, minor: ndarray, incl: ndarray, phase: ndarray)[source]

Calculates currents u, v using the four tidal ellipse parameters from Foreman’s formula [20]

Parameters:

major: np.ndarray: amplitude of the semi-major axis
minor: np.ndarray: amplitude of the semi-minor axis
incl: np.ndarray: angle of inclination of the northern semi-major axis
phase: np.ndarray: phase lag of the maximum current behind the maximum tidal potential

Returns:

pyTMD.ellipse._xy(major: float | ndarray, minor: float | ndarray, incl: float | ndarray, **kwargs)[source]

Calculates the x and y coordinates of the tidal ellipse

Parameters:

major: np.ndarray: amplitude of the semi-major axis
minor: np.ndarray: amplitude of the semi-minor axis
incl: np.ndarray: angle of inclination of the northern semi-major axis
phase: np.ndarray or None, default None: phase lag of the maximum current behind the maximum tidal potential
xy: tuple, default (0.0, 0.0): center of the ellipse (x, y)
N: int or None, default None: number of points to calculate along the ellipse

Returns: