fr.cnes.sirius.patrius.bodies

Class CelestialBodyTabulatedOrientation

java.lang.Object

fr.cnes.sirius.patrius.bodies.CelestialBodyTabulatedOrientation

All Implemented Interfaces:

CelestialBodyOrientation, Serializable

public class CelestialBodyTabulatedOrientation
extends Object
implements CelestialBodyOrientation

Celestial body orientation represented by a tabulated attitude leg (quaternions).

Since:

4.13

Author:

Thibaut BONIT

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
CelestialBodyTabulatedOrientation(TabulatedAttitude tabulatedAttitude) Constructor.

Method Summary

Modifier and Type	Method and Description
AngularCoordinates	getAngularCoordinates(AbsoluteDate date, CelestialBodyOrientation.OrientationType orientationType) Getter for the orientation.
double	getDH() Getter for the finite difference delta value.
TimeStampedAngularCoordinates	getOrientation(AbsoluteDate date) Getter for the celestial body orientation at the specified date in the tabulated attitude leg's reference frame.
TimeStampedAngularCoordinates	getOrientation(AbsoluteDate date, Frame frame) Getter for the celestial body orientation at the specified date.
Vector3D	getPole(AbsoluteDate date) 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.
double	getPrimeMeridianAngle(AbsoluteDate date) Getter for the prime meridian angle.
double	getPrimeMeridianAngleDerivative(AbsoluteDate date) Getter for the prime meridian angle derivative.
TabulatedAttitude	getTabulatedAttitude() Getter for the tabulated attitude leg representing the celestial body orientation.
void	setDH(double dHIn) Setter for the finite difference delta value.
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.CelestialBodyOrientation

getAngularCoordinates

Constructor Detail

CelestialBodyTabulatedOrientation

public CelestialBodyTabulatedOrientation(TabulatedAttitude tabulatedAttitude)

Constructor.

Parameters:

tabulatedAttitude - The tabulated attitude leg representing the celestial body orientation

Method Detail

getTabulatedAttitude

public TabulatedAttitude getTabulatedAttitude()

Getter for the tabulated attitude leg representing the celestial body orientation.

Returns:

the tabulated attitude leg

getOrientation

public TimeStampedAngularCoordinates getOrientation(AbsoluteDate date)
                                             throws PatriusException

Getter for the celestial body orientation at the specified date in the tabulated attitude leg's reference frame.

Parameters:

date - current date

Returns:

the celestial body orientation

Throws:

PatriusException - if attitude cannot be computed for provided date

getOrientation

public TimeStampedAngularCoordinates getOrientation(AbsoluteDate date,
                                                    Frame frame)
                                             throws PatriusException

Getter for the celestial body orientation at the specified date.

Parameters:

date - current date

frame - reference frame from which attitude is computed

Returns:

the celestial body orientation

Throws:

PatriusException - if attitude cannot be computed for provided date

getDH

public double getDH()

Getter for the finite difference delta value.

This value is used to compute the body pole directions by finite difference (see getPole(fr.cnes.sirius.patrius.time.AbsoluteDate) and getPoleDerivative(fr.cnes.sirius.patrius.time.AbsoluteDate).

Note that the body pole directions can only be computed on the interval:
[tabulated attitude's lower date + 2 * dH ; tabulated attitude's upper date - 2 * dH].

Returns:

the finite difference delta value

setDH

public void setDH(double dHIn)

Setter for the finite difference delta value.

This value is used to compute the body pole directions by finite difference (see getPole(fr.cnes.sirius.patrius.time.AbsoluteDate) and getPoleDerivative(fr.cnes.sirius.patrius.time.AbsoluteDate).

Note that the body pole directions can only be computed on the interval:
[tabulated attitude's lower date + 2 * dH ; tabulated attitude's upper date - 2 * dH].

Parameters:

dHIn - the finite difference delta value to set (0.5s by default)

Throws:

NotStrictlyPositiveException - if dH < Precision.DOUBLE_COMPARISON_EPSILON

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

getPole

public Vector3D getPole(AbsoluteDate date)
                 throws PatriusException

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

Throws:

PatriusException - if attitude cannot be computed for provided date

getPoleDerivative

public Vector3D getPoleDerivative(AbsoluteDate date)
                           throws PatriusException

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

Throws:

PatriusException - if attitude cannot be computed for provided date

getPrimeMeridianAngle

public double getPrimeMeridianAngle(AbsoluteDate date)
                             throws PatriusException

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

Throws:

PatriusException - if attitude cannot be computed for provided date

getPrimeMeridianAngleDerivative

public double getPrimeMeridianAngleDerivative(AbsoluteDate date)
                                       throws PatriusException

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

Throws:

PatriusException - if attitude cannot be computed for provided date

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