ellipse

Expresses the amplitudes and phases for the u and v components in terms of four ellipse parameters using Foreman’s formula [21]
- Semi-major axis
- Semi-minor axis
- Inclination
- Phase angle

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 [21]

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 [21]

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: