fr.cnes.sirius.patrius.bodies

Class UserIAUPole

java.lang.Object

fr.cnes.sirius.patrius.bodies.UserIAUPole

All Implemented Interfaces:

CelestialBodyIAUOrientation, CelestialBodyOrientation, Serializable

public class UserIAUPole
extends Object
implements CelestialBodyIAUOrientation

Generic IAU pole model for pole and prime meridian orientations.

This class represents the model compliant with the report of the IAU/IAG Working Group on Cartographic Coordinates and Rotational Elements of the Planets and Satellites (WGCCRE). These definitions are common for all recent versions of this report published every three years.

The precise values of pole direction and W angle coefficients may vary from publication year as models are adjusted. The latest value of constants for implementing this interface can be found in the working group site.

Since:

4.7

Author:

Emmanuel Bignon

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface fr.cnes.sirius.patrius.bodies.CelestialBodyOrientation

CelestialBodyOrientation.OrientationType

Constructor Summary

Constructors

Constructor and Description
UserIAUPole(IAUPoleCoefficients coefficients) Constructor.

Method Summary

Modifier and Type	Method and Description
AngularCoordinates	getAngularCoordinates(AbsoluteDate date, CelestialBodyOrientation.OrientationType orientationType) Getter for the orientation.
AngularCoordinates	getAngularCoordinates(AbsoluteDate date, CelestialBodyOrientation.OrientationType orientationType, IAUPoleModelType iauPoleType) Getter for the orientation.
Vector3D	getPole(AbsoluteDate date) Getter for the body North pole direction with respect to a reference frame.
Vector3D	getPole(AbsoluteDate date, IAUPoleModelType iauPoleType) Getter for the body North pole direction with respect to a reference frame.
Vector3D	getPoleDerivative(AbsoluteDate date) Getter for the body North pole direction derivative with respect to a reference frame.
Vector3D	getPoleDerivative(AbsoluteDate date, IAUPoleModelType iauPoleType) Getter for the body North pole direction derivative with respect to a reference frame.
double	getPrimeMeridianAngle(AbsoluteDate date) Getter for the prime meridian angle.
double	getPrimeMeridianAngle(AbsoluteDate date, IAUPoleModelType iauPoleType) Getter for the prime meridian angle.
double	getPrimeMeridianAngleDerivative(AbsoluteDate date) Getter for the prime meridian angle derivative.
double	getPrimeMeridianAngleDerivative(AbsoluteDate date, IAUPoleModelType iauPoleType) Getter for the prime meridian angle derivative.
String	toString() Returns a string representation of the body orientation.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface fr.cnes.sirius.patrius.bodies.CelestialBodyIAUOrientation

getAngularCoordinates

Methods inherited from interface fr.cnes.sirius.patrius.bodies.CelestialBodyOrientation

getAngularCoordinates

Constructor Detail

UserIAUPole

public UserIAUPole(IAUPoleCoefficients coefficients)

Constructor.

Parameters:

coefficients - model coefficients

Method Detail

getPole

public Vector3D getPole(AbsoluteDate date)

Getter for the body North pole direction with respect to a reference frame.
It takes into account constant, secular and harmonics terms (conversion from ICRF to true equator).

Specified by:

getPole in interface CelestialBodyOrientation

Parameters:

date - Current date

Returns:

the body North pole direction with respect to a reference frame

getPole

public Vector3D getPole(AbsoluteDate date,
                        IAUPoleModelType iauPoleType)

Getter for the body North pole direction with respect to a reference frame.

Specified by:

getPole in interface CelestialBodyIAUOrientation

Parameters:

date - Current date

iauPoleType - IAUPole data to take into account for ICRF/inertial/mean equator/true equator transformation

Returns:

the body North pole direction with respect to a reference frame

getPoleDerivative

public Vector3D getPoleDerivative(AbsoluteDate date)

Getter for the body North pole direction derivative with respect to a reference frame.
It takes into account constant, secular and harmonics terms (conversion from ICRF to true equator).

Specified by:

getPoleDerivative in interface CelestialBodyOrientation

Parameters:

date - Current date

Returns:

the body North pole direction derivative with respect to a reference frame

getPoleDerivative

public Vector3D getPoleDerivative(AbsoluteDate date,
                                  IAUPoleModelType iauPoleType)

Getter for the body North pole direction derivative with respect to a reference frame.
It takes into account constant, secular and harmonics terms (conversion from ICRF to true equator).

Specified by:

getPoleDerivative in interface CelestialBodyIAUOrientation

Parameters:

date - Current date

iauPoleType - IAUPole data to take into account for ICRF/inertial/mean equator/true equator transformation

Returns:

the body North pole direction derivative with respect to a reference frame

getPrimeMeridianAngle

public double getPrimeMeridianAngle(AbsoluteDate date)

Getter for the prime meridian angle.
It takes into account constant, secular and harmonics terms (conversion from ICRF to true rotating).

The prime meridian angle is the angle between the Q node and the prime meridian. Represents the body rotation.

Specified by:

getPrimeMeridianAngle in interface CelestialBodyOrientation

Parameters:

date - Current date

Returns:

the prime meridian vector

getPrimeMeridianAngle

public double getPrimeMeridianAngle(AbsoluteDate date,
                                    IAUPoleModelType iauPoleType)

Getter for the prime meridian angle.

The prime meridian angle is the angle between the Q node and the prime meridian. Represents the body rotation.

Specified by:

getPrimeMeridianAngle in interface CelestialBodyIAUOrientation

Parameters:

date - Current date

iauPoleType - IAUPole data to take into account for ICRF/inertial/mean rotating/true rotating transformation

Returns:

the prime meridian vector

getPrimeMeridianAngleDerivative

public double getPrimeMeridianAngleDerivative(AbsoluteDate date)

Getter for the prime meridian angle derivative.
It takes into account constant, secular and harmonics terms (conversion from ICRF to true rotating).

The prime meridian angle is the angle between the Q node and the prime meridian. Represents the body rotation.

Specified by:

getPrimeMeridianAngleDerivative in interface CelestialBodyOrientation

Parameters:

date - Current date

Returns:

the prime meridian angle derivative

getPrimeMeridianAngleDerivative

public double getPrimeMeridianAngleDerivative(AbsoluteDate date,
                                              IAUPoleModelType iauPoleType)

Getter for the prime meridian angle derivative.

The prime meridian angle is the angle between the Q node and the prime meridian. Represents the body rotation.

Specified by:

getPrimeMeridianAngleDerivative in interface CelestialBodyIAUOrientation

Parameters:

date - Current date

iauPoleType - IAUPole data to take into account for ICRF/inertial/mean rotating/true rotating transformation

Returns:

the prime meridian angle derivative

getAngularCoordinates

public AngularCoordinates getAngularCoordinates(AbsoluteDate date,
                                                CelestialBodyOrientation.OrientationType orientationType)
                                         throws PatriusException

Getter for the orientation.

Specified by:

getAngularCoordinates in interface CelestialBodyOrientation

Parameters:

date - Current date

orientationType - Indicates the expected orientation type

Returns:

the orientation

Throws:

PatriusException - if attitude cannot be computed for provided date

getAngularCoordinates

public AngularCoordinates getAngularCoordinates(AbsoluteDate date,
                                                CelestialBodyOrientation.OrientationType orientationType,
                                                IAUPoleModelType iauPoleType)
                                         throws PatriusException

Getter for the orientation.

Specified by:

getAngularCoordinates in interface CelestialBodyIAUOrientation

Parameters:

date - Current date

orientationType - Indicates the expected orientation type

iauPoleType - IAUPole data to take into account for ICRF/inertial/mean rotating/true rotating transformation

Returns:

the orientation

Throws:

PatriusException - if attitude cannot be computed for provided date

toString

public String toString()

Returns a string representation of the body orientation.

Specified by:

toString in interface CelestialBodyOrientation

Overrides:

toString in class Object

Returns:

a string representation of the body orientation