agi.foundation.celestial

(agi.foundation.models-2024r3.jar)

Class Precession

java.lang.Object

agi.foundation.celestial.Precession

All Implemented Interfaces:

IEquatable<Precession>

public final class Precession
extends Object
implements IEquatable<Precession>

Holds precession angles.

Precession is represented by three angles: Zeta (get), Theta (get), and Z (get), which compose a rotation in order of Zeta (get) about the third axis, Theta (get) about the second axis, and Z (get) about the third axis.

Constructor Summary

Constructors

Constructor and Description
Precession(double zeta, double z, double theta, double meanObliquity) Initializes a new instance with the specified parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Indicates whether another object is exactly equal to this instance.
static boolean	equals(Precession left, Precession right) Returns true if the two instances are exactly equal.
boolean	equalsType(Precession other) Indicates whether another instance of this type is exactly equal to this instance.
double	getMeanObliquity() Gets the mean obliquity of the ecliptic, in radians.
double	getTheta() Gets the accumulated precession angle theta, in radians, used to tilt the x-y-plane to the mean equator of date.
double	getZ() Gets the accumulated precession angle z, in radians, used to align the x-axis with the mean equinox of date by rotating along the mean equator of date.
double	getZeta() Gets the accumulated precession angle zeta, in radians, used to align the x-axis toward the direction in which the pole is to be tilted off of the ICRF z-axis.
int	hashCode() Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.
static boolean	notEquals(Precession left, Precession right) Returns true if the two instances are not exactly equal.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Precession

public Precession(double zeta,
                  double z,
                  double theta,
                  double meanObliquity)

Initializes a new instance with the specified parameters.

Parameters:

zeta - The accumulated precession angle zeta, in radians, used to align the x-axis toward the direction in which the pole is to be tilted off of the ICRF z-axis.

z - The accumulated precession angle z, in radians, used to align the x-axis with the mean equinox of date by rotating along the mean equator of date.

theta - The accumulated precession angle theta, in radians, used to tilt the x-y-plane to the mean equator of date.

meanObliquity - The mean obliquity of the ecliptic, in radians.

Method Detail

getZeta

public final double getZeta()

Gets the accumulated precession angle zeta, in radians, used to align the x-axis toward the direction in which the pole is to be tilted off of the ICRF z-axis.

getZ

public final double getZ()

Gets the accumulated precession angle z, in radians, used to align the x-axis with the mean equinox of date by rotating along the mean equator of date.

getTheta

public final double getTheta()

Gets the accumulated precession angle theta, in radians, used to tilt the x-y-plane to the mean equator of date.

getMeanObliquity

public final double getMeanObliquity()

Gets the mean obliquity of the ecliptic, in radians.

equalsType

public final boolean equalsType(Precession other)

Indicates whether another instance of this type is exactly equal to this instance.

Specified by:

equalsType in interface IEquatable<Precession>

Parameters:

other - The instance to compare to this instance.

Returns:

true if other represents the same value as this instance; otherwise false.

equals

public boolean equals(Object obj)

Indicates whether another object is exactly equal to this instance.

Overrides:

equals in class Object

Parameters:

obj - The object to compare to this instance.

Returns:

true if obj is an instance of this type and represents the same value as this instance; otherwise false.

See Also:

Object.hashCode(), HashMap

hashCode

public int hashCode()

Returns a hash code for this instance, which is suitable for use in hashing algorithms and data structures like a hash table.

Overrides:

hashCode in class Object

Returns:

A hash code for the current object.

See Also:

Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

equals

public static boolean equals(Precession left,
                             Precession right)

Returns true if the two instances are exactly equal.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left represents the same value as right; otherwise false.

notEquals

public static boolean notEquals(Precession left,
                                Precession right)

Returns true if the two instances are not exactly equal.

Parameters:

left - The instance to compare to right.

right - The instance to compare to left.

Returns:

true if left does not represent the same value as right; otherwise false.