- Generated on Wed Jul 3 2024 16:34:48 for PCL by
1.9.1
|
PCL
|
Solar system ephemerides from XEPH files. More...
#include <EphemerisFile.h>
Classes | |
| class | Handle |
| Calculation of ephemerides from data stored in XEPH files. More... | |
Public Member Functions | |
| EphemerisFile ()=default | |
| EphemerisFile (const EphemerisFile &)=delete | |
| EphemerisFile (const String &filePath) | |
| EphemerisFile (EphemerisFile &&x) | |
| virtual | ~EphemerisFile () noexcept(false) |
| void | Close () |
| const EphemerisConstantList & | Constants () const |
| double | ConstantValue (const IsoString &name) const |
| TimePoint | EndTime () const |
| const String & | FilePath () const |
| bool | IsConstantAvailable (const IsoString &name) const |
| bool | IsObjectAvailable (const IsoString &object, const IsoString &origin=IsoString()) const |
| bool | IsOpen () const |
| const EphemerisMetadata & | Metadata () const |
| int | NumberOfHandles () const |
| IsoStringList | ObjectIds () const |
| String | ObjectName (const IsoString &object, const IsoString &origin=IsoString()) const |
| StringList | ObjectNames () const |
| EphemerisObjectList | Objects () const |
| void | Open (const String &filePath) |
| EphemerisFile & | operator= (const EphemerisFile &)=delete |
| EphemerisFile & | operator= (EphemerisFile &&x) |
| TimePoint | StartTime () const |
This class implements ephemerides of solar system bodies computed from data stored in XEPH (Extensible Ephemeris Data format) files. It also implements serialization of ephemeris data in the XEPH file format.
On the PixInsight/PCL platform, the XEPH file format allows for efficient ephemeris calculations through Chebyshev polynomial expansions stored as raw binary data. An XEPH file stores multiple arrays of Chebyshev coefficient series accessible by means of fast indexed file search algorithms and structures, along with auxiliary data and metadata required for ephemeris calculations.
Calculation of state vectors (such as position and velocity vectors) for specific objects is performed through a dedicated client subclass, namely EphemerisFile::Handle. This class implements transparent file seek and read operations, as well as fast, lock-free multithreaded evaluation of Chebyshev polynomials.
XEPH ephemeris files allow for calculation of rectangular coordinates referred to the axes of the International Celestial Reference System (ICRS/J2000.0). Positions are given in au and velocities in au/day for all solar system objects, except planetocentric coordinates of natural satellites, including the geocentric Moon, for which positions and velocities are given in kilometers and km/day, respectively. Angles (nutations and librations) are given in radians, and time differences (such as TT-TDB) in seconds.
An XEPH file storing up-to-date JPL DE/LE ephemeris data is part of all standard PixInsight distributions since 1.8.5 versions released Fall 2018. As of writing this documentation (June 2024), the standard XEPH file provides the complete JPL DE440 planetary and lunar ephemerides. See the EphemerisFile::FundamentalEphemerides() static member function for detailed information.
Definition at line 798 of file EphemerisFile.h.
|
default |
Default constructor.
Constructs an invalid instance that cannot be used until initialized by calling the Open() member function.
|
inline |
Constructs an &EphemerisFile instance initialized from the specified ephemeris data file in XEPH format.
In the event of errors or invalid data, this constructor will throw the appropriate Error exception.
Definition at line 817 of file EphemerisFile.h.
|
inline |
Move constructor.
Definition at line 825 of file EphemerisFile.h.
|
delete |
Deleted copy constructor. EphemerisFile instances are unique, hence cannot be copied.
|
virtualnoexcept |
Virtual destructor.
|
static |
Returns a reference to the global asteroid ephemerides file currently defined by the running PixInsight platform.
Under normal running conditions, the returned object provides ephemeris data for a set of asteroids with relevant masses. In a standard asteroid ephemeris file, object identifiers are asteroid numbers and object names are asteroid designations; for example:
| Identifier | Name |
| 1 | Ceres |
| 2 | Pallas |
| 3 | Juno |
| 4 | Vesta |
| 5 | Astraea |
| ... | ... |
| 702 | Alauda |
| 703 | Noemi |
| 704 | Interamnia |
| ... | ... |
Asteroid ephemeris data are provided relative to the solar system barycenter ("SSB" identifier), with position and velocity coordinates coherent with global fundamental ephemerides.
As of writing this documentation, the standard asteroid ephemeris file provides the complete set of 343 asteroids used for the numerical integration of JPL DE440 and DE441 ephemerides.
The asteroid ephemeris file can be overridden by the caller module. See the OverrideAsteroidEphemerides() member function for more information.
This static member function is thread-safe. It can be called safely from multiple execution threads running concurrently.
|
static |
Returns the path to the global database file of CIP positions referred to the ITRS.
The position of the Celestial Intermediate Pole (CIP) in the International Terrestrial Reference System (ITRS) is necessary to compute polar motion corrections applied to topocentric coordinates of solar system bodies. These corrections are relevant for the topocentric position of the Moon at the milliarcsecond level.
In current versions of PixInsight the CIP_ITRS database is a plain text file generated with values provided by the IERS Rapid Service/Prediction Center. As of writing this documentation (June 2024), the main online reference is:
https://datacenter.iers.org/data/latestVersion/ 186_EOP_C01_2000.1846_NOW_V2013_01186.txt
| void pcl::EphemerisFile::Close | ( | ) |
Closes the ephemeris file represented by this object and resets all internal structures to a default, uninitialized state.
If a previous file was already opened by this instance, it will be closed and all associated control and file indexing structures will be destroyed and deallocated. If no file is currently open, calling this member has no effect.
|
inline |
Returns a reference to the dynamic list of constants stored in the ephemeris data file represented by this object. These constants are name/value pairs, where keys are 8-bit strings and values are double precision floating point numbers.
Typically, for XEPH files that store fundamental JPL DE/LE ephemerides this member function returns the list of constants used by the corresponding DE/LE numerical integration.
The returned list is sorted by constant name in ascending order.
Definition at line 947 of file EphemerisFile.h.
|
inline |
Returns the value of an ephemeris constant given by its name.
If no constant is available with the specified name (case-insensitive) in the XEPH file represented by this object, this function throws an Error exception.
Definition at line 969 of file EphemerisFile.h.
References pcl::BinarySearch().
|
static |
Returns the path to the global database file of Delta AT values.
Delta AT is the difference TAI-UTC in seconds. In current versions of PixInsight the Delta AT database is a plain text file generated with values taken from the following online reference:
http://maia.usno.navy.mil/ser7/tai-utc.dat (now unavailable)
Delta AT data files are expected to follow a simple format where each text line provides a UTC/DeltaAT pair. The exact format is described at the top of the corresponding file included in the current PixInsight distribution.
The Delta AT database file can be overridden by the caller module. See the OverrideDeltaATDataFilePath() member function for more information.
This static member function is thread-safe. It can be called safely from multiple execution threads running concurrently.
|
static |
Returns the path to the global database file of observed Delta T values.
Delta T is the difference TT-UT1 in seconds. In current versions of PixInsight the Delta T database is a plain text file generated with values taken from the following online references:
For the period 1657-1956.0:
http://maia.usno.navy.mil/ser7/historic_deltat.data (now unavailable)
For the period 1956 Jan 19 to the date of release:
https://datacenter.iers.org/data/latestVersion/ 186_EOP_C01_2000.1846_NOW_V2013_01186.txt
The Delta T database usually includes a few extrapolated values covering a short period after the date of release. These extrapolated values must always be taken only as approximations; actual Delta T values are unpredictable and can only be known through observations.
Delta T data files are expected to follow a simple format where each text line provides a TT/DeltaT pair. The exact format is described at the top of the corresponding file included in the current PixInsight distribution.
Outside of the period from 1657 to the last time point included in the Delta T database, the current PixInsight/PCL implementation uses polynomial expressions taken from:
Five Millennium Canon of Solar Eclipses, by Fred Espenak and Jean Meeus (NASA/TP–2006–214141, Revision 1.0, 2007).
The Delta T database file can be overridden by the caller module. See the OverrideDeltaTDataFilePath() member function for more information.
This static member function is thread-safe. It can be called safely from multiple execution threads running concurrently.
|
inline |
Ending point of the time span covered by this ephemeris, or the latest time point for which ephemerides can be calculated using this object.
Definition at line 930 of file EphemerisFile.h.
|
inline |
Returns the path of the ephemeris file represented by this object. Returned file paths are always absolute, full file paths.
Definition at line 911 of file EphemerisFile.h.
|
static |
Returns a reference to the global fundamental ephemerides file currently defined by the running PixInsight platform.
Under normal running conditions, the returned object provides ephemeris data for at least the following objects:
| Identifier | Name |
| Me | Mercury |
| Ve | Venus |
| EMB | Earth-Moon barycenter |
| Ma | Mars' barycenter |
| Ju | Jupiter's barycenter |
| Sa | Saturn's barycenter |
| Ur | Uranus' barycenter |
| Ne | Neptune's barycenter |
| Pl | Pluto's barycenter |
| Mn | Moon's geometric center with respect to Earth's center. |
| Sn | Sun's geometric center |
| Ea | Earth's geometric center |
With the only exception of the Moon ("Mn" identifier), ephemeris data for all of the objects above are provided relative to the solar system barycenter ("SSB" identifier).
Additional items may also be available, depending on specific file versions and compilations:
| Identifier | Name |
| Lbr | Lunar librations (Euler angles) in radians |
| Nut | Nutation angles in radians |
| TT_TDB | TT-TDB difference at the geocenter in seconds. |
As of writing this documentation (June 2024), the standard fundamental ephemeris file provides the complete JPL DE440 planetary and lunar ephemerides, but nutations, librations and time differences are not included.
The fundamental ephemeris file can be overridden by the caller module. See the OverrideFundamentalEphemerides() member function for more information.
This static member function is thread-safe. It can be called safely from multiple execution threads running concurrently.
|
inline |
Returns true iff this instance knows a numerical constant with the specified name.
Definition at line 956 of file EphemerisFile.h.
References pcl::BinarySearch().
|
inline |
Returns true iff this instance contains ephemeris data for the specified object, given by its identifier or name, with respect to the specified origin.
The specified object string can be either an object identifier (case-sensitive), or an object name (case-insensitive) encoded as UTF-8. For example, all of 'Ju', 'Jupiter', 'jupiter' and 'JUPITER' refer to Jupiter in a standard XEPH file storing fundamental JPL DE/LE ephemerides. In this example, 'Ju' is a case-sensitive object identifier, thus 'ju' and 'JU' are not valid and this function would return false for both of them.
origin is the identifier of an origin of coordinates. If an empty string is specified (which is the default parameter value), this function will return true if the file contains any ephemeris data for the specified object, irrespective of the origin. Otherwise an exact match of the origin identifier will be required.
See the FundamentalEphemerides() static member function for information about the objects supported by standard XEPH files storing fundamental ephemerides.
Definition at line 1043 of file EphemerisFile.h.
|
inline |
Returns true iff this object has an open ephemeris file and is ready for ephemeris data retrieval.
Definition at line 902 of file EphemerisFile.h.
|
static |
Returns a reference to the global Kuiper belt objects (KBOs) ephemerides file currently defined by the running PixInsight platform.
As of writing this documentation (June 2024), the default KBO ephemerides file includes the set of 30 most massive known trans-Neptunian objects used in JPL's DE440 numerical integration:
| Identifier | Name |
| 19521 | Chaos |
| 20000 | Varuna |
| 28978 | Ixion |
| 42301 | 2001 UR163 |
| 50000 | Quaoar |
| 55565 | 2002 AW197 |
| 55637 | 2002 UX25 |
| 84522 | 2002 TC302 |
| 90377 | Sedna |
| 90482 | Orcus |
| 90568 | 2004 GV9 |
| 120347 | Salacia |
| 136108 | Haumea |
| 136199 | Eris |
| 136472 | Makemake |
| 145452 | 2005 RN43 |
| 174567 | Varda |
| 208996 | 2003 AZ84 |
| 225088 | Gonggong |
| 230965 | 2004 XA192 |
| 278361 | 2007 JJ43 |
| 307261 | 2002 MS4 |
| 455502 | 2003 UZ413 |
| 523639 | 2010 RE64 |
| 528381 | 2008 ST291 |
| 2004 XR190 | |
| 2006 QH181 | |
| 2010 FX86 | |
| 2010 KZ39 | |
| 2010 RF43 |
KBO ephemeris data are provided relative to the solar system barycenter ("SSB" identifier), with position and velocity coordinates coherent with global fundamental ephemerides. These ephemerides have been generated by numerical integration with starting state vectors provided by official NASA/JPL asteroid databases.
The KBO ephemeris file can be overridden by the caller module. See the OverrideKBOEphemerides() member function for more information.
This static member function is thread-safe. It can be called safely from multiple execution threads running concurrently.
|
inline |
Returns a reference to the (immutable) metadata items available in the ephemeris data file loaded by this object.
Definition at line 1081 of file EphemerisFile.h.
|
inline |
Returns the number of handles currently active for this ephemeris file.
If an EphemerisFile object has active handles, also known as child handles, destroying it will most likely lead to a crash, since any activity performed by a child handle will make reference to a nonexistent parent object.
This function is thread-safe.
Definition at line 1098 of file EphemerisFile.h.
|
static |
Returns a reference to the global nutation model ephemeris file currently defined by the running PixInsight platform.
Under normal running conditions, the returned object provides Chebyshev polynomial expansions for the current IAU nutation model. As of writing this documentation, the standard nutation model file provides the IAU 2006/2000A_R nutation model (MHB2000 luni-solar and planetary nutation with adjustments to match the IAU 2006 precession).
The returned object should provide at least one object with the "IAUNut" identifier, which can be used to approximate the implemented nutation theory with a child EphemerisFile::Handle object.
The nutation model ephemeris file can be overridden by the caller module. See the OverrideNutationModel() member function for more information.
This static member function is thread-safe. It can be called safely from multiple execution threads running concurrently.
|
inline |
Returns a dynamic list of object identifiers for all the objects available in this file.
Definition at line 1000 of file EphemerisFile.h.
|
inline |
Returns the name of the specified object, with respect to the specified origin.
Both object and origin must be object identifiers. If origin is an empty string (which is the default parameter value), this function will return the name of the first object found with the specified identifier, irrespective of the origin. Otherwise an exact match of the origin identifier will be required.
If no object with the required conditions is available in this ephemeris file, this function returns an empty string.
Definition at line 1069 of file EphemerisFile.h.
|
inline |
Returns a dynamic list of object names for all the objects available in this file.
Definition at line 1012 of file EphemerisFile.h.
|
inline |
Returns a dynamic list of EphemerisObject instances describing all of the objects available in this file for ephemeris calculations.
The returned list is sorted by object and origin identifiers (in that order of precedence) in ascending order.
Definition at line 985 of file EphemerisFile.h.
| void pcl::EphemerisFile::Open | ( | const String & | filePath | ) |
Initializes this object to give access to the specified ephemeris data file in XEPH format.
This member function opens an existing file at the specified filePath, loads and parses its XML header, and loads the file indexes ready for fast access to ephemeris data. The file will remain open until this object is destroyed, or until a new call to this function is made.
If a previous file was already opened by this instance, it will be closed and all associated control and file indexing structures will be destroyed and deallocated, before accessing the new file.
|
delete |
Deleted copy assignment operator. EphemerisFile instances are unique, hence cannot be copied.
|
inline |
Move assignment operator. Returns a reference to this object.
Definition at line 837 of file EphemerisFile.h.
|
static |
Override the default asteroid ephemerides file.
The specified filePath must be a valid path to an existing file in XEPH format, which must provide asteroid ephemerides coherent with the global fundamental ephemerides being used. See the AsteroidEphemerides() member function for a more comprehensive description.
After calling this member function, all asteroid ephemerides will be calculated using the specified XEPH file, which will be installed automatically upon the first call to AsteroidEphemerides().
This function is useful to build standalone applications that don't depend on a running PixInsight core application, which is necessary to retrieve the default file names and directories from global settings.
|
static |
Override the global database of CIP positions in the ITRS.
The specified filePath must be a valid path to an existing file in a plain text database format compatible with the standard CIP_ITRS database included in PixInsight distributions. See the CIP_ITRSDataFilePath() member function for more details.
After calling this member function, CIP coordinates in the ITRS will be calculated by interpolation from the data provided by the specified file, which will be loaded and parsed automatically upon the first call (explicit or implicit) to Position::CIP_ITRS(). However, for performance and modularization reasons, once a CIP_ITRS database has been loaded there is no way to change it, so calling this function again will have no effect.
This function is useful to build standalone applications that don't depend on a running PixInsight core application, which is necessary to retrieve the default file names and directories from global settings.
|
static |
Override the global Delta AT database.
The specified filePath must be a valid path to an existing file in a plain text database format compatible with the standard Delta AT database included in PixInsight distributions. See the DeltaATDataFilePath() member function for more details.
After calling this member function, Delta AT values will be calculated by interpolation from the data provided by the specified file, which will be loaded and parsed automatically upon the first call (explicit or implicit) to TimePoint::DeltaAT(). However, for performance and modularization reasons, once a Delta AT database has been loaded there is no way to change it, so calling this function again will have no effect.
This function is useful to build standalone applications that don't depend on a running PixInsight core application, which is necessary to retrieve the default file names and directories from global settings.
|
static |
Override the global Delta T database.
The specified filePath must be a valid path to an existing file in a plain text database format compatible with the standard Delta T database included in PixInsight distributions. See the DeltaTDataFilePath() member function for more details.
After calling this member function, Delta T values will be calculated by interpolation from the data provided by the specified file, which will be loaded and parsed automatically upon the first call (explicit or implicit) to TimePoint::DeltaT(). However, for performance and modularization reasons, once a Delta T database has been loaded there is no way to change it, so calling this function again will have no effect.
This function is useful to build standalone applications that don't depend on a running PixInsight core application, which is necessary to retrieve the default file names and directories from global settings.
|
static |
Override the default fundamental ephemerides file.
The specified filePath must be a valid path to an existing file in XEPH format, which must provide fundamental solar system ephemerides. See the FundamentalEphemerides() member function for a comprehensive description.
After calling this member function, all fundamental ephemerides will be calculated using the specified XEPH file, which will be installed automatically upon the first call to FundamentalEphemerides().
This function is useful to build standalone applications that don't depend on a running PixInsight core application, which is necessary to retrieve the default file names and directories from global settings.
|
static |
Override the default Kuiper belt objects (KBOs) ephemerides file.
The specified filePath must be a valid path to an existing file in XEPH format, which must provide KBO ephemerides coherent with the global fundamental ephemerides being used. See the KBOEphemerides() member function for a more comprehensive description.
After calling this member function, all KBO ephemerides will be calculated using the specified XEPH file, which will be installed automatically upon the first call to KBOEphemerides().
This function is useful to build standalone applications that don't depend on a running PixInsight core application, which is necessary to retrieve the default file names and directories from global settings.
|
static |
Override the global nutation model ephemeris file.
The specified filePath must be a valid path to an existing file in XEPH format, which must provide estimates of nutation angles compliant with the current IAU nutation model. See the NutationModel() member function for more details.
After calling this member function, the nutation model used for ephemeris calculations will be provided by the specified XEPH file, which will be installed automatically upon the first call to NutationModel().
This function is useful to build standalone applications that don't depend on a running PixInsight core application, which is necessary to retrieve the default file names and directories from global settings.
|
static |
Override the default short-term asteroid ephemerides file.
The specified filePath must be a valid path to an existing file in XEPH format, which must provide asteroid ephemerides coherent with the global fundamental ephemerides being used. See the AsteroidEphemerides() member function for a more comprehensive description.
After calling this member function, all short-term asteroid ephemerides will be calculated using the specified XEPH file, which will be installed automatically upon the first call to ShortTermAsteroidEphemerides().
This function is useful to build standalone applications that don't depend on a running PixInsight core application, which is necessary to retrieve the default file names and directories from global settings.
|
static |
Override the default short-term fundamental ephemerides file.
The specified filePath must be a valid path to an existing file in XEPH format, which must provide fundamental solar system ephemerides. See the FundamentalEphemerides() member function for a comprehensive description.
After calling this member function, all short-term fundamental ephemerides will be calculated using the specified XEPH file, which will be installed automatically upon the first call to ShortTermFundamentalEphemerides().
This function is useful to build standalone applications that don't depend on a running PixInsight core application, which is necessary to retrieve the default file names and directories from global settings.
|
static |
Override the default short-term Kuiper belt objects (KBOs) ephemerides file.
The specified filePath must be a valid path to an existing file in XEPH format, which must provide KBO ephemerides coherent with the global fundamental ephemerides being used. See the KBOEphemerides() member function for a more comprehensive description.
After calling this member function, short-term KBO ephemerides will be calculated using the specified XEPH file, which will be installed automatically upon the first call to ShortTermKBOEphemerides().
This function is useful to build standalone applications that don't depend on a running PixInsight core application, which is necessary to retrieve the default file names and directories from global settings.
|
static |
Override the global short-term nutation model ephemeris file.
The specified filePath must be a valid path to an existing file in XEPH format, which must provide estimates of nutation angles compliant with the current IAU nutation model. See the NutationModel() member function for more details.
After calling this member function, the nutation model used for short-term ephemeris calculations will be provided by the specified XEPH file, which will be installed automatically upon the first call to ShortTermNutationModel().
This function is useful to build standalone applications that don't depend on a running PixInsight core application, which is necessary to retrieve the default file names and directories from global settings.
|
static |
Generates a file to store solar system ephemeris data in XEPH format.
| filePath | Path to the file that will be generated in the local filesystem. The file name should carry the '.xeph' suffix. |
| startTime | Lower bound of the entire time span for which the ephemeris data being serialized is valid. |
| endTime | Upper bound of the entire time span for which the ephemeris data being serialized is valid. |
| data | Reference to an array of per-object ephemeris data, including Chebyshev polynomial expansions for the ephemeris function (such as position) and, optionally, for its first derivative (such as velocity), as well as object identifiers and object names. |
| metadata | Reference to an EphemerisMetadata structure with optional metadata information that will be included in the generated XEPH file. |
| constants | Reference to an array of name/value pairs used to represent a set of numerical constants relevant to the ephemerides being serialized If an empty array is specified (as the default parameter value), no numerical constant will be included in the generated XEPH file. |
The entire time span covered by an ephemeris file, from startTime to endTime, is usually subdivided into many small chunks or subspans, each of them with a relatively short polynomial expansion. The duration of each subspan is defined in a way such that the motion of the object for which positions are being calculated is sufficiently smooth to be fitted within the time subspan by truncated Chebyshev polynomials with relatively few coefficients (typically in the range of 15 to 30 coefficients) to achieve a prescribed accuracy. The faster and more perturbed the object's motion is, the more and shorter subspans are necessary to fit an accurate representation of the object's orbit.
In the event of invalid, incongruent or malformed data, or if an I/O error occurs, this function will throw an Error exception.
|
static |
Returns a reference to the global short-term asteroid ephemerides file currently defined by the running PixInsight platform.
See the AsteroidEphemerides() static member function for information on asteroid ephemerides and their status in current versions of PixInsight.
Under normal running conditions, the returned object should be a shortened version (that is, covering a shorter time span) of the standard asteroid ephemerides file. As of writing this documentation, the standard short-term asteroid ephemeris file covers the period from 1950 January 1.0 to 2100 January 32.0.
The short-term asteroid ephemeris file can be overridden by the caller module. See the OverrideShortTermAsteroidEphemerides() member function for more information.
This static member function is thread-safe. It can be called safely from multiple execution threads running concurrently.
|
static |
Returns a reference to the global short-term fundamental ephemerides file currently defined by the running PixInsight platform.
See the FundamentalEphemerides() static member function for information on fundamental ephemerides and their status in current versions of PixInsight.
Under normal running conditions, the returned object should be a shortened version (that is, covering a shorter time span) of the standard fundamental ephemerides file. As of writing this documentation (June 2024), the standard short-term fundamental ephemeris file provides DE440 ephemerides for the period from 1850 January 1.0 to 2150 December 32.0.
The short-term fundamental ephemeris file can be overridden by the caller module. See the OverrideShortTermFundamentalEphemerides() member function for more information.
This static member function is thread-safe. It can be called safely from multiple execution threads running concurrently.
|
static |
Returns a reference to the global short-term Kuiper belt objects (KBOs) ephemerides file currently defined by the running PixInsight platform.
See the KBOEphemerides() static member function for information on asteroid ephemerides and their status in current versions of PixInsight.
Under normal running conditions, the returned object should be a shortened version (that is, covering a shorter time span) of the standard KBO ephemerides file. As of writing this documentation, the standard short-term asteroid ephemeris file covers the period from 1950 January 1.0 to 2100 January 32.0.
The short-term KBO ephemeris file can be overridden by the caller module. See the OverrideShortTermKBOEphemerides() member function for more information.
This static member function is thread-safe. It can be called safely from multiple execution threads running concurrently.
|
static |
Returns a reference to the global short-term nutation model ephemeris file currently defined by the running PixInsight platform.
See the NutationModel() static member function for information on nutation model ephemerides and their status in current versions of PixInsight.
Under normal running conditions, the returned object should be a shortened version (that is, covering a shorter time span) of the standard nutation model ephemerides file. As of writing this documentation, the standard short-term nutation model file provides the IAU 2006/2000A_R nutation model for the period from 1850 January 1.0 to 2150 December 32.0.
The returned object should provide at least one object with the "IAUNut" identifier, which can be used to approximate the implemented nutation theory with a child EphemerisFile::Handle object.
The short-term nutation model ephemeris file can be overridden by the caller module. See the OverrideShortTermNutationModel() member function for more information.
This static member function is thread-safe. It can be called safely from multiple execution threads running concurrently.
|
inline |
Starting point of the time span covered by this ephemeris, or the earliest time point for which ephemerides can be calculated using this object.
Definition at line 921 of file EphemerisFile.h.
1.9.1