fr.cnes.sirius.patrius.bodies

Interface CelestialBodyIAUOrientation

All Superinterfaces:

CelestialBodyOrientation, Serializable

All Known Implementing Classes:

UserIAUPole

public interface CelestialBodyIAUOrientation
extends CelestialBodyOrientation

Interface for IAU pole and primer meridian orientations.

This interface defines methods 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.

Author:

Luc Maisonobe

See Also:

CelestialBodyFactory

Nested Class Summary

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

CelestialBodyOrientation.OrientationType

Method Summary

Modifier and Type	Method and Description
AngularCoordinates	getAngularCoordinates(AbsoluteDate date, CelestialBodyOrientation.OrientationType orientationType, IAUPoleModelType iauPoleType) Getter for the orientation.
default AngularCoordinates	getAngularCoordinates(AbsoluteDate date, IAUPoleModelType iauPoleType) Getter for the orientation from the ICRF frame to the rotating frame.
Vector3D	getPole(AbsoluteDate date, IAUPoleModelType iauPoleType) Getter for the body North pole direction 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, IAUPoleModelType iauPoleType) Getter for the prime meridian angle.
double	getPrimeMeridianAngleDerivative(AbsoluteDate date, IAUPoleModelType iauPoleType) Getter for the prime meridian angle derivative.

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

getAngularCoordinates, getAngularCoordinates, getPole, getPoleDerivative, getPrimeMeridianAngle, getPrimeMeridianAngleDerivative, toString

Method Detail

getPole

Vector3D getPole(AbsoluteDate date,
                 IAUPoleModelType iauPoleType)

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

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

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).

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

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.

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

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.

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

default AngularCoordinates getAngularCoordinates(AbsoluteDate date,
                                                 IAUPoleModelType iauPoleType)
                                          throws PatriusException

Getter for the orientation from the ICRF frame to the rotating frame.

Parameters:

date - Current date

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

Returns:

the orientation from the ICRF frame to the rotating frame

Throws:

PatriusException - if attitude cannot be computed for provided date

getAngularCoordinates

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

Getter for the orientation.

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