Package org.orekit.frames

This package provides classes to handle frames and transforms between them.

The Transform class represents a full transform: combined rotation and translation, and their first time derivatives to handle kinematics.

Each Frame is defined by a transform linking it to another one, called its parent frame. The only exception is the root frame which has no parent. This implies that all frames are naturally organized as a tree with a single root. The predefined GCRF inertial frame was arbitrary chosen as the root for every tree.

The FramesFactory class implements several predefined reference frames. One set correspond to the frames from the various IERS conventions (ITRF and others). Other frames not belonging to the previous set are the EME2000 frame that was used prior to GCRF and which is linked to GCRF by a simple bias rotation, the MOD (Mean Of Date) frame which involves the IAU 1976 precession model, the TOD (True Of Date) frame which involves the IAU 1980 nutation model, the GTOD (Greenwich True Of Date) which involves the IAU 1982 Greenwich sidereal time model and the Veis 1950 frame which involves a Veis modified sidereal time model.

Some other frames are predefined outside of this package, in the CelestialBodies class. They correspond to the Sun, Moon, planets, solar system barycenter and Earth-Moon barycenter. For convenience, the very important solar system barycenter frame, which is the ICRF, can also be retrieved from the factory in this package even if it is really implemented in the bodies package.

The frames can be time dependent (for example the ITRF frame depends on time due to precession/nutation, Earth rotation and pole motion). In order to get a transform from one frame to another one, the date must be specified, and TransformProvider.getTransform(AbsoluteDate) is called under the hood. If a user wants to implement his own date synchronized frame, he has to implement his own TransformProvider class and provide it to the frame constructor.

Author:

Luc Maisonobe, Fabien Maussion, Véronique Pommier-Maurussane, Pascal Parraud

Interface Summary

Interface	Description
EOPBasedTransformProvider	Interface for Transform providers that use Earth Orientation Parameters.
EopHistoryLoader	Interface for loading Earth Orientation Parameters history.
EopHistoryLoader.Parser	Interface for parsing EOP data files.
FieldKinematicTransform<T extends CalculusFieldElement<T>>	A transform that only includes translation and rotation as well as their respective rates.
FieldStaticTransform<T extends CalculusFieldElement<T>>	A transform that only includes translation and rotation.
Frames	A collection of commonly used Frames.
ItrfVersionProvider	Interface for retrieving the ITRF version for a given set of EOP data.
KinematicTransform	A transform that only includes translation and rotation as well as their respective rates.
LOF	Interface for local orbital frame.
StaticTransform	A transform that only includes translation and rotation.
TransformProvider	Interface for Transform providers.

Class Summary

Class	Description
AbstractEopLoader	Base class for EOP loaders.
AbstractFrames	This class is an implementation of Frames that creates frames when they are first used and uses synchronization to ensure that each frame is only created once.
CR3BPRotatingFrame	Class creating the rotating frame centered on the barycenter of the CR3BP System.
EclipticProvider	An inertial frame aligned with the ecliptic.
EOPEntry	This class holds an Earth Orientation Parameters entry.
EOPFittedModel	Container for fitted model for Earth Orientation Parameters.
EOPFitter	Earth Orientation Parameters fitter for EOP prediction.
EOPHistory	This class loads any kind of Earth Orientation Parameter data throughout a large time range.
FactoryManagedFrame	Base class for the predefined frames that are managed by Frames.
FieldPoleCorrection<T extends CalculusFieldElement<T>>	Simple container class for pole correction parameters.
FieldTransform<T extends CalculusFieldElement<T>>	Transformation class in three-dimensional space.
FieldTransformGenerator<T extends CalculusFieldElement<T>>	Generator to use field transforms in GenericTimeStampedCache.
FixedTransformProvider	Transform provider using fixed transform.
Frame	Tridimensional references frames class.
FramesFactory	Factory for predefined reference frames.
GTODProvider	Greenwich True Of Date Frame, also known as True of Date Rotating frame (TDR) or Greenwich Rotating Coordinate frame (GCR).
HelmertTransformation	Transformation class for geodetic systems.
InterpolatingTransformProvider	Transform provider using thread-safe interpolation on transforms sample.
ITRFVersion.Converter	Specialized transform provider between ITRF frames.
ITRFVersionLoader	Loader for ITRF version configuration file.
ITRFVersionLoader.ITRFVersionConfiguration	ITRF version configuration entry.
L1Frame	Class to create a L1 centered frame with L1TransformProvider.
L1TransformProvider	L1 Transform provider for a frame on the L1 Lagrange point of two celestial bodies.
L2Frame	Class to create a L2 centered frame with L2TransformProvider.
LazyLoadedEop	Loads Earth Orientation Parameters (EOP) from a configured set of EopHistoryLoaders on demand.
LazyLoadedFrames	This class lazily loads auxiliary data when it is needed by a requested frame.
LocalMagneticFieldFrame	This class handles a magnetic field variation attitude provider.
LocalOrbitalFrame	Class for frames moving with an orbiting satellite.
OrphanFrame	Prototype frame that can be built from leaf to roots and later attached to a tree.
PoleCorrection	Simple container class for pole correction parameters.
PredictedEOPHistory	This class extends an EOPHistory for some weeks using fitting.
ShiftingTransformProvider	Transform provider using thread-safe shifts on transforms sample.
SingleParameterFitter	Fitter for one Earth Orientation Parameter.
TopocentricFrame	Topocentric frame.
Transform	Transformation class in three dimensional space.
TransformGenerator	Generator to use transforms in GenericTimeStampedCache.
TransformProviderUtils	Utility for Transform providers.
TwoBodiesBaryFrame	Class creating the inertial barycenter frame from two bodies.
UpdatableFrame	Frame whose transform from its parent can be updated.
VersionedITRF	Specific version of International Terrestrial Reference Frame.

Enum Summary

Enum	Description
HelmertTransformation.Predefined	Enumerate for predefined Helmert transformations.
ITRFVersion	Enumerate for ITRF versions.
LocalMagneticFieldFrame.LOFBuilderVector	Enum defining how the +j axis of the local orbital frame will be defined.
LOFType	Enumerate for different types of Local Orbital Frames.
Predefined	Predefined frames provided by Frames.