Class LazyLoadedFrames
- java.lang.Object
-
- org.orekit.frames.AbstractFrames
-
- org.orekit.frames.LazyLoadedFrames
-
- All Implemented Interfaces:
Frames
public class LazyLoadedFrames extends AbstractFrames
This class lazily loads auxiliary data when it is needed by a requested frame. It is designed to match the behavior ofFramesFactory
in Orekit 10.0.- Since:
- 10.1
- Author:
- Guylaine Prat, Luc Maisonobe, Pascal Parraud, Evan Ward
- See Also:
LazyLoadedEop
-
-
Constructor Summary
Constructors Constructor Description LazyLoadedFrames(LazyLoadedEop lazyLoadedEop, TimeScales timeScales, CelestialBodies celestialBodies)
Create a collection of frames from the given auxiliary data.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description void
addDefaultEOP1980HistoryLoaders(String rapidDataColumnsSupportedNames, String xmlSupportedNames, String eopC04SupportedNames, String bulletinBSupportedNames, String bulletinASupportedNames, String csvSupportedNames)
Add the default loaders EOP history (IAU 1980 precession/nutation).void
addDefaultEOP2000HistoryLoaders(String rapidDataColumnsSupportedNames, String xmlSupportedNames, String eopC04SupportedNames, String bulletinBSupportedNames, String bulletinASupportedNames, String csvSupportedNames)
Add the default loaders for EOP history (IAU 2000/2006 precession/nutation).void
addEOPHistoryLoader(IERSConventions conventions, EopHistoryLoader loader)
Add a loader for Earth Orientation Parameters history.void
clearEOPHistoryLoaders()
Clear loaders for Earth Orientation Parameters history.EOPHistory
getEOPHistory(IERSConventions conventions, boolean simpleEOP)
Get Earth Orientation Parameters history.void
setEOPContinuityThreshold(double threshold)
Set the threshold to check EOP continuity.-
Methods inherited from class org.orekit.frames.AbstractFrames
buildUncachedITRF, getCIRF, getEcliptic, getEME2000, getFrame, getGCRF, getGTOD, getGTOD, getICRF, getITRF, getITRF, getITRFEquinox, getMOD, getMOD, getPZ9011, getTEME, getTimeScales, getTIRF, getTIRF, getTOD, getTOD, getVeis1950
-
-
-
-
Constructor Detail
-
LazyLoadedFrames
public LazyLoadedFrames(LazyLoadedEop lazyLoadedEop, TimeScales timeScales, CelestialBodies celestialBodies)
Create a collection of frames from the given auxiliary data.- Parameters:
lazyLoadedEop
- loads Earth Orientation Parameters.timeScales
- defines the time scales used when computing frame transformations. For example, the TT time scale needed forAbstractFrames.getPZ9011(IERSConventions, boolean)
.celestialBodies
- defines the celestial bodies which, for example, are used inAbstractFrames.getICRF()
.
-
-
Method Detail
-
addDefaultEOP1980HistoryLoaders
public void addDefaultEOP1980HistoryLoaders(String rapidDataColumnsSupportedNames, String xmlSupportedNames, String eopC04SupportedNames, String bulletinBSupportedNames, String bulletinASupportedNames, String csvSupportedNames)
Add the default loaders EOP history (IAU 1980 precession/nutation).The default loaders look for IERS EOP C04 and bulletins B files. They correspond to
IERS 1996
conventions.- Parameters:
rapidDataColumnsSupportedNames
- regular expression for supported rapid data columns EOP files names (may be null if the default IERS file names are used)xmlSupportedNames
- regular expression for supported XML EOP files names (may be null if the default IERS file names are used)eopC04SupportedNames
- regular expression for supported EOP C04 files names (may be null if the default IERS file names are used)bulletinBSupportedNames
- regular expression for supported bulletin B files names (may be null if the default IERS file names are used)bulletinASupportedNames
- regular expression for supported bulletin A files names (may be null if the default IERS file names are used)csvSupportedNames
- regular expression for supported csv files names (may be null if the default IERS file names are used)- Since:
- 12.0
- See Also:
- IERS https data download,
addEOPHistoryLoader(IERSConventions, EopHistoryLoader)
,clearEOPHistoryLoaders()
,addDefaultEOP2000HistoryLoaders(String, String, String, String, String, String)
-
addDefaultEOP2000HistoryLoaders
public void addDefaultEOP2000HistoryLoaders(String rapidDataColumnsSupportedNames, String xmlSupportedNames, String eopC04SupportedNames, String bulletinBSupportedNames, String bulletinASupportedNames, String csvSupportedNames)
Add the default loaders for EOP history (IAU 2000/2006 precession/nutation).The default loaders look for IERS EOP C04 and bulletins B files. They correspond to both
IERS 2003
andIERS 2010
conventions.- Parameters:
rapidDataColumnsSupportedNames
- regular expression for supported rapid data columns EOP files names (may be null if the default IERS file names are used)xmlSupportedNames
- regular expression for supported XML EOP files names (may be null if the default IERS file names are used)eopC04SupportedNames
- regular expression for supported EOP C04 files names (may be null if the default IERS file names are used)bulletinBSupportedNames
- regular expression for supported bulletin B files names (may be null if the default IERS file names are used)bulletinASupportedNames
- regular expression for supported bulletin A files names (may be null if the default IERS file names are used)csvSupportedNames
- regular expression for supported csv files names (may be null if the default IERS file names are used)- Since:
- 12.0
- See Also:
- IERS https data download,
addEOPHistoryLoader(IERSConventions, EopHistoryLoader)
,clearEOPHistoryLoaders()
,addDefaultEOP1980HistoryLoaders(String, String, String, String, String, String)
-
addEOPHistoryLoader
public void addEOPHistoryLoader(IERSConventions conventions, EopHistoryLoader loader)
Add a loader for Earth Orientation Parameters history.- Parameters:
conventions
- IERS conventions to which EOP history appliesloader
- custom loader to add for the EOP history- See Also:
addDefaultEOP1980HistoryLoaders(String, String, String, String, String, String)
,clearEOPHistoryLoaders()
-
clearEOPHistoryLoaders
public void clearEOPHistoryLoaders()
Clear loaders for Earth Orientation Parameters history.
-
setEOPContinuityThreshold
public void setEOPContinuityThreshold(double threshold)
Set the threshold to check EOP continuity.The default threshold (used if this method is never called) is 5 Julian days. If after loading EOP entries some holes between entries exceed this threshold, an exception will be triggered.
One case when calling this method is really useful is for applications that use a single Bulletin A, as these bulletins have a roughly one month wide hole for the first bulletin of each month, which contains older final data in addition to the rapid data and the predicted data.
- Parameters:
threshold
- threshold to use for checking EOP continuity (in seconds)
-
getEOPHistory
public EOPHistory getEOPHistory(IERSConventions conventions, boolean simpleEOP)
Get Earth Orientation Parameters history.If no
EopHistoryLoader
has been added by callingaddEOPHistoryLoader
or ifclearEOPHistoryLoaders
has been called afterwards, theaddDefaultEOP1980HistoryLoaders(String, String, String, String, String, String)
andaddDefaultEOP2000HistoryLoaders(String, String, String, String, String, String)
methods will be called automatically with supported file names parameters all set to null, in order to get the default loaders configuration.- Parameters:
conventions
- conventions for which EOP history is requestedsimpleEOP
- if true, tidal effects are ignored when interpolating EOP- Returns:
- Earth Orientation Parameters history
-
-