Commit a9af54f9 authored by Jakob Stierhof's avatar Jakob Stierhof

Fix Help in date functions

Please make sure there is spacing in the description! Otherwise 'help'
will pick up on the words that are not preceeded by a space.
parent edbacb6c
Pipeline #6532 passed with stages
in 42 seconds
......@@ -4,10 +4,10 @@ define tai2tt()
%\synopsis{Convert a (M)JD in International Atomic Time into Terrestrial Time (TT, also known as TDT or ET)}
%\usage{tt=tai2tt(JD)}
%\description
%This routine converts a Julian Date that is given in International Atomic
%Time (TAI) into Terrestrial Time, which is roughly corresponding to
%Terrestrial Dynamic Time or Ephemeris Time. This is done by
%adding 32.184s to the TT. This routine is array safe.
% This routine converts a Julian Date that is given in International Atomic
% Time (TAI) into Terrestrial Time, which is roughly corresponding to
% Terrestrial Dynamic Time or Ephemeris Time. This is done by
% adding 32.184s to the TT. This routine is array safe.
%
%\qualifiers{
%\qualifier{mjd}{The argument is given in MJD, not in JD.}
......
......@@ -4,12 +4,12 @@ define tt2tcg()
%\synopsis{Convert a (M)JD in Terrestrial Time (TT, aka TDT or ET) into TCG}
%\usage{tai=tt2tcg(JD)}
%\description
%This routine converts a Julian Date that is given in Terrestrial Time
%(formerly known as Terrestrial Dynamic Time or Ephemeris Time) into
%geocentric coordinate time (TCG). The two time scales differ by a constant
%rate(!) because TT uses the SI second at the surface of the geoid, and TCG uses
%the SI second at the potential of the center of the Earth.
% This routine is array safe.
% This routine converts a Julian Date that is given in Terrestrial Time
% (formerly known as Terrestrial Dynamic Time or Ephemeris Time) into
% geocentric coordinate time (TCG). The two time scales differ by a constant
% rate(!) because TT uses the SI second at the surface of the geoid, and TCG uses
% the SI second at the potential of the center of the Earth.
% This routine is array safe.
%\qualifiers{
%\qualifier{mjd}{The argument is given in MJD, not in JD.}
%\qualifier{deltat}{Return the TCG-TT in seconds, rather than the corrected (M)JD.}
......@@ -60,11 +60,11 @@ define tcg2tt()
%\synopsis{Convert a (M)JD in TCG to Terrestrial Time (TT, aka TDT or ET)}
%\usage{tai=tcg2tt(JD)}
%\description
%This routine converts a Julian Date that is given in geocentric coordinate
%time (TCG) to Terrestrial Time. The two time scales differ by a constant
%rate(!) because TT uses the SI second at the surface of the geoid, and TCG
%uses the SI second at the potential of the center of the Earth.
% This routine is array safe.
% This routine converts a Julian Date that is given in geocentric coordinate
% time (TCG) to Terrestrial Time. The two time scales differ by a constant
% rate(!) because TT uses the SI second at the surface of the geoid, and TCG
% uses the SI second at the potential of the center of the Earth.
% This routine is array safe.
%\qualifiers{
%\qualifier{mjd}{The argument is given in MJD, not in JD.}
%\qualifier{deltat}{Return the TT-TCG in seconds, rather than the corrected (M)JD.}
......
......@@ -4,23 +4,23 @@ define tt2tdb()
%\synopsis{Convert a (M)JD in Terrestrial Time (TT, aka TDT or ET) into Terrestrial Barycentric Time (TDB)}
%\usage{tdb=tt2tdb(JD)}
%\description
%This function converts a Julian Date that is given in Terrestrial
%Time into Terrestrial Dynamic Barycentric Time.
% This function converts a Julian Date that is given in Terrestrial
% Time into Terrestrial Dynamic Barycentric Time.
%
%By default the routine uses equation 2.6 of Kaplan (2005, USNO Circular 179), which
%is a truncated version of the series provided by Fairhead and Bretagnon,
%1990, A&A 229, 240 and which is better than +/-10mus between AD1600 and AD2200.
% By default the routine uses equation 2.6 of Kaplan (2005, USNO Circular 179), which
% is a truncated version of the series provided by Fairhead and Bretagnon,
% 1990, A&A 229, 240 and which is better than +/-10mus between AD1600 and AD2200.
%
%If the qualifier ephemeris is given, and points to a JPL ephemeris that
%does contain TT-TDB information, then the value determined from the
%ephemeris is computed (which has a higher precision than Fairhead & Bretagnon,
%but is slower to evaluate).
% If the qualifier ephemeris is given, and points to a JPL ephemeris that
% does contain TT-TDB information, then the value determined from the
% ephemeris is computed (which has a higher precision than Fairhead & Bretagnon,
% but is slower to evaluate).
%
%Note that for virtually all practical applications apart from barycentering
%ms radio pulsar data it is sufficient to use TT as the argument to DE405
%or VSOP1987.
% Note that for virtually all practical applications apart from barycentering
% ms radio pulsar data it is sufficient to use TT as the argument to DE405
% or VSOP1987.
%
%This routine is array safe.
% This routine is array safe.
%\qualifiers{
%\qualifier{mjd}{The argument is given in MJD, not in JD.}
%\qualifier{deltat}{Return the difference TDB-TT in seconds, rather than the corrected (M)JD.}
......@@ -100,30 +100,30 @@ define tdb2tt()
%\synopsis{Convert a (M)JD in Terrestrial Barycentric Time (TDB) into Terrestrial Time (TT, aka TDT)}
%\usage{tt=tdb2tt(JD)}
%\description
%This function converts a Julian Date that is given in Terrestrial Barycentric
%time (TDB) into Terrestrial Time (TT).
% This function converts a Julian Date that is given in Terrestrial Barycentric
% time (TDB) into Terrestrial Time (TT).
%
%By default the routine uses equation 2.6 of Kaplan (2005, USNO Circular 179),
%which is a truncated version of the series provided by Fairhead and Bretagnon,
%1990, A&A 229, 240 and which is better than +/-10mus between AD1600 and
%AD2200.
% By default the routine uses equation 2.6 of Kaplan (2005, USNO Circular 179),
% which is a truncated version of the series provided by Fairhead and Bretagnon,
% 1990, A&A 229, 240 and which is better than +/-10mus between AD1600 and
% AD2200.
%
%Since that series is for TT-TDB, we formally calculate the deltat for the TT
%that equals the given JD, we make no attempt to correct for the slight
%change in deltat between JD(TT) and JD(TDB), since the correction is smaller
%than the precision of the Fairhead and Bretagnon series. Use the JPL ephemeris
%for ms pulsar work.
% Since that series is for TT-TDB, we formally calculate the deltat for the TT
% that equals the given JD, we make no attempt to correct for the slight
% change in deltat between JD(TT) and JD(TDB), since the correction is smaller
% than the precision of the Fairhead and Bretagnon series. Use the JPL ephemeris
% for ms pulsar work.
%
%If the qualifier ephemeris is given, and points to a JPL ephemeris that
%does contain TT-TDB information, then the value determined from the
%ephemeris is computed (which has a higher precision than Fairhead & Bretagnon,
%but is slower to evaluate).
% If the qualifier ephemeris is given, and points to a JPL ephemeris that
% does contain TT-TDB information, then the value determined from the
% ephemeris is computed (which has a higher precision than Fairhead & Bretagnon,
% but is slower to evaluate).
%
%Note that for virtually all practical applications apart from barycentering
%ms radio pulsar data it is sufficient to use TT as the argument to DE405
%or VSOP1987.
% Note that for virtually all practical applications apart from barycentering
% ms radio pulsar data it is sufficient to use TT as the argument to DE405
% or VSOP1987.
%
%This routine is array safe.
% This routine is array safe.
%\qualifiers{
%\qualifier{mjd}{The argument is given in MJD, not in JD.}
%\qualifier{deltat}{Return the difference TT-TDB in seconds, rather than the corrected (M)JD.}
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment