fr.cnes.sirius.patrius.frames.transformations

Class TODProvider

java.lang.Object

fr.cnes.sirius.patrius.frames.transformations.TODProvider

All Implemented Interfaces:

TransformProvider, Serializable

public final class TODProvider
extends Object
implements TransformProvider

True Equator, Mean Equinox of Date Frame.

This frame handles nutation effects according to the IAU-80 theory.

Its parent frame is the MODProvider.

It is sometimes called True of Date (ToD) frame.

Author:

Pascal Parraud

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
TODProvider(boolean applyEOPCorr) Simple constructor.

Method Summary

Modifier and Type	Method and Description
static double	getEquationOfEquinoxes(AbsoluteDate date) Get the Equation of the Equinoxes at the current date.
PoleCorrection	getPoleCorrection(AbsoluteDate date) Get the pole IERS Reference Pole correction.
Transform	getTransform(AbsoluteDate date) Get the transform from Mean Of Date at specified date.
Transform	getTransform(AbsoluteDate date, boolean computeSpinDerivatives) Get the transform from Mean Of Date at specified date.
Transform	getTransform(AbsoluteDate date, FramesConfiguration config) Get the transform from Mean Of Date at specified date.
Transform	getTransform(AbsoluteDate date, FramesConfiguration config, boolean computeSpinDerivatives) Get the transform from Mean Of Date at specified date.

Methods inherited from class java.lang.Object

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

Constructor Detail

TODProvider

public TODProvider(boolean applyEOPCorr)
            throws PatriusException

Simple constructor.

Parameters:

applyEOPCorr - if true, EOP correction is applied (here, nutation)

Throws:

PatriusException - if EOP parameters are desired but cannot be read

Method Detail

getPoleCorrection

public PoleCorrection getPoleCorrection(AbsoluteDate date)
                                 throws TimeStampedCacheException

Get the pole IERS Reference Pole correction.

The data provided comes from the IERS files. It is smoothed data.

Parameters:

date - date at which the correction is desired

Returns:

pole correction (PoleCorrection.NULL_CORRECTION if date is outside covered range)

Throws:

TimeStampedCacheException - if no eop data available

getTransform

public Transform getTransform(AbsoluteDate date,
                              FramesConfiguration config)
                       throws PatriusException

Get the transform from Mean Of Date at specified date.

The update considers the nutation effects from IERS data.

Specified by:

getTransform in interface TransformProvider

Parameters:

date - new value of the date

config - frames configuration to use

Returns:

transform at the specified date

Throws:

PatriusException - if the nutation model data embedded in the library cannot be read

getTransform

public Transform getTransform(AbsoluteDate date,
                              FramesConfiguration config,
                              boolean computeSpinDerivatives)
                       throws PatriusException

Get the transform from Mean Of Date at specified date.

The update considers the nutation effects from IERS data.

Specified by:

getTransform in interface TransformProvider

Parameters:

date - new value of the date

config - frames configuration to use

computeSpinDerivatives - unused param

Returns:

transform at the specified date

Throws:

PatriusException - if the nutation model data embedded in the library cannot be read

getTransform

public Transform getTransform(AbsoluteDate date)
                       throws PatriusException

Get the transform from Mean Of Date at specified date.

The update considers the nutation effects from IERS data.

Specified by:

getTransform in interface TransformProvider

Parameters:

date - new value of the date

Returns:

transform at the specified date

Throws:

PatriusException - if the nutation model data embedded in the library cannot be read

getTransform

public Transform getTransform(AbsoluteDate date,
                              boolean computeSpinDerivatives)
                       throws PatriusException

Get the transform from Mean Of Date at specified date.

The update considers the nutation effects from IERS data.

Specified by:

getTransform in interface TransformProvider

Parameters:

date - new value of the date

computeSpinDerivatives - unused param

Returns:

transform at the specified date

Throws:

PatriusException - if the nutation model data embedded in the library cannot be read

getEquationOfEquinoxes

public static double getEquationOfEquinoxes(AbsoluteDate date)
                                     throws PatriusException

Get the Equation of the Equinoxes at the current date.

Parameters:

date - the date

Returns:

equation of the equinoxes

Throws:

PatriusException - if nutation model cannot be computed