Recent Changes - Search:

edit SideBar

Plugins

Chapter 8: The graphical interfaces and output formats

By default, tempo2 provides a simple, text-only output of the pre- and post-fit timing parameters. One of the main strengths of tempo2 is the ability for individual users to produce code in C or C++ that can interact or "plugin" to the main software. This allows the user to produce new "output formats" (that control the final output of the timing parameters or the residuals) or "graphical interfaces" that provide full control to the plugin and allows residuals to be viewed, processed, re-fit and so forth. Details for producing these plugins are provided in Appendix A of this documentation. Full documentation and downloads of the currently available plugins can be obtained from the plugins page on this wiki.

8.1 The output formats

The default output format provides the pre- and post-fit rms residuals, the number of points in the fit and, if a weighted fit has been carried out, the reduced chisquared-value of the fit. For each parameter, the values of the pre- and post-fit parameters are listed alongside the uncertainty in the post-fit value and the difference between the pre- and post-fit values. A flag indicates whether the parameter was included in the fit. For binary systems, the default output format also provides details on the binary model and lists, if possible, the mass function, minimum, median and maximum companion masses, the total system mass and the inclination angle. An example is given below:

 Results for PSR J0437-4715


 RMS pre-fit residual = 6.895 (us), RMS post-fit residual = 0.096 (us)
 Number of points in fit = 367


 PARAMETER       Pre-fit                   Post-fit                  Uncertainty   Difference   Fit
 ---------------------------------------------------------------------------------------------------
 RAJ (rad)       1.2097885336826           1.20978853474746          2.1206e-11    1.0649e-09    Y
 RAJ (hms)       04:37:15.7865              04:37:15.7865146         2.916e-07     1.4643e-05   
 DECJ (rad)      -0.824709094076948        -0.824709094473468        1.5157e-11    -3.9652e-10   Y
 DECJ (dms)      -47:15:08.4615            -47:15:08.46158           3.1264e-06    -8.1788e-05  
 F0 (s^-1)       173.68794630603           173.687946306032          9.5579e-15    2.3306e-12    Y
 F1 (s^-2)       -1.728e-15                -1.72831367406148e-15     2.3325e-22    -3.1367e-19   Y
 PEPOCH (MJD)    51194.0001248168          51194.0001248168          0             0             N
 POSEPOCH (MJD)  51194.0001248168          51194.0001248168          0             0             N
 DMEPOCH (MJD)   51194                     51194                     0             0             N
 DM (cm^-3 pc)   2.64690012312213          2.64690012312213          0             0             N
 PMRA (mas/yr)   121.43799811708           121.43799811708           0             0             N
 PMDEC (mas/yr)  -71.4379988923397         -71.4379988923397         0             0             N
 PX (mas)        7.19                      7.19                      0             0             N
 SINI            0.6788                    0.6788                    0             0             N
 PB (d)          5.741046089               5.74104608900813          1.0437e-11    8.1286e-12    Y
 T0 (MJD)        51194.6240248265          51194.6240248265          0             0             N
 A1 (lt-s)       3.36669162220122          3.36669162220122          0             0             N
 OM (deg)        1.2                       1.2                       0             0             N
 ECC             1.9186e-05                1.9186e-05                0             0             N
 PBDOT (10^-12)  3.64                      3.64                      0             0             N
 OMDOT (deg/yr)  0.0159999997519168        0.0159999997519168        0             0             N
 M2              0.236                     0.236                     0             0             N
 START (MJD)     50640.9281162413          49350.5129309451          0             -1290.4       N
 FINISH (MJD)    52088.8971386924          53000.5197060478          0             911.62        N
 TRACK (MJD)     0                         0                         0             0             N
 TZRMJD          51204.6438924841          51204.6438924841          0             0             N
 TZRFRQ (MHz)    1413.39997808495          1413.39997808495          0             0             N
 ---------------------------------------------------------------------------------------------------
 Binary model: DD
 Mass function                  = 0.001243113190  +- 0.000000047151 solar masses 
 Minimum companion mass         = 0.1403 solar masses
 Median companion mass          = 0.1637 solar masses
 Maximum companion mass         = 0.3493 solar masses
 MTOT derived from sin i and m2 = 1.818606841374
 Inclination angle (deg)        = 42.74994182955 (+ 0 - 0)

Other output format have been developed and can be accessed using:

 tempo2 -output NAME -f mypar.par mytim.tim

where NAME is the name of the output format. Examples of various output formats are shown below. More details can be found on the plugins page.

8.1.1 The general output format

The general output format allows the user to present the fitted parameters in a user-specified way. For instance,

 tempo2 -output general -s "{NORAD}{ALL_f}{TAB 20} & {ALL_p} {TAB 50}\n" -f psr.par psr.tim

will produce output in a LaTeX format:

 RAJ (rad)            &  18:02:05.33496(12)        
DECJ (rad) & -21:24:03.72(6)
F0 (s^-1) & 79.066424253435(18)
F1 (s^-2) & -4.574E-16(13)
PEPOCH (MJD) & 52855
POSEPOCH (MJD) & 52855
DMEPOCH (MJD) & 52855
DM (cm^-3 pc) & 149.666066
PB (d) & 0.69888924320(20)
A1 (lt-s) & 3.718853847
TASC (MJD) & 52595.795078543
EPS1 & 1.0412e-06
EPS2 & 2.3924e-06
START (MJD) & 52605.162
FINISH (MJD) & 53565.334
TRACK (MJD) & 0
TZRMJD & 52883.440856822
TZRFRQ (MHz) & 1390

8.1.2 The general2 output format

The general2 output plugin is used to output per-datum (per-TOA) values in a user-specified format. This includes the site-arrival-times, clock corrections, timing residuals and so forth. For example the Shapiro delay due to Jupiter and the post-fit residuals can be displayed using

 tempo2 -output general2 -f par.par tim.tim -s "{bat} {shapiroJ} {post}\n"

In detail, the command-line options are:

optiondescription
-s stringFormat data according to string
-file fileRead formatting from file
-outfile fileSend formatted data to outfile rather than standard out

Data available through the plugin are:

keywordmeaning
satBarycentric arrival time
batBarycentric arrival time
bbatBinary barycentric arrival time
clock0Clock correction number 0
clock1Clock correction number 1
clock2Clock correction number 2
clock3Clock correction number 3
clock4Clock correction number 4
ut1UT1 correction
delWhether the TOA was deleted
einsteinEinstein rate
fileFilename the TOA came from (via INCLUDEs)
solarangleAngle from the Sun
shapiroSolar Shapiro delay - note solar not binary
shapiroJJupiter Shapiro delay
shapiroSSaturn Shapiro delay
shapiroVVenus Shapiro delay
shapiroUUranus Shapiro delay
shapiroNNeptune Shapiro delay
roemerRoemer delay (light travel time across the Earth's orbit)
flagsFlags associated with TOA in input file
tropoTropospheric delay
ttCorrection to TT
TttTOA corrected to TT
t2tbCorrection including TT and tt2tb
tt2tbCorrection from TT to TDB
earth_ssbVector from Earth to solar system barycenter
earth_ssb1x-component of vector from Earth to solar system barycenter
earth_ssb2y-component of vector from Earth to solar system barycenter
earth_ssb3z-component of vector from Earth to solar system barycenter
earth_ssb4time derivative of x-component of vector from Earth to solar system barycenter
earth_ssb5time derivative of y-component of vector from Earth to solar system barycenter
earth_ssb6time derivative of z-component of vector from Earth to solar system barycenter
sun_ssb1x-component of vector from Sun to solar system barycenter
sun_ssb2y-component of vector from Sun to solar system barycenter
sun_ssb3z-component of vector from Sun to solar system barycenter
sun_earth1x-component of vector from Sun to Earth
sun_earth2y-component of vector from Sun to Earth
sun_earth3z-component of vector from Sun to Earth
d_parameterPartial derivative with respect to parameter, post-fit
ismISM delay
elevSource elevation (neglecting proper motion)
posPulsar 
velPulsar 
siteVel0 
siteVel1 
siteVel2 
posTelPosition of telescope in Earth-centered coordinates
dtCOETime delay to centre of Earth
telSSBTelescope position with respect to solar system barycenter
telVelTelescope velocity with respect to solar system barycenter
zenithTelescope zenith vector (?)
npulsePulse number
clockTotal clock correction
clk_corr1 
clk_corr2 
clk2 
clkchainChain of clock corrections used
ipmInterplanetary medium correction
fmjdu 
xBAT - epoch
freqObserving frequency
freqSSBObserving frequency at solar system barycenter
freqCOEApprox. observing frequency at centre of Earth
prePre-fit residual
pre_phasePre-fit residual in phase
postPost-fit residual
post_phasePost-fit residual in phase
errTOA error
binphaseBinary phase

Data keywords are case-insensitive.

In addition to the data printing keywords, there are keywords that serve as commands to the plugin:

keywordmeaning
format cUse c as a printf-style string to format values and errors
errmult cMultiply all errors by c
tab nAdvance to column n
null sDisplay the string s for null (non-available) values
sub1Subtract first residual from remainder
RADDoes not appear to do anything but set a flag. Upper-case only.
NORADNo RAD, not NORAD.

Command keywords are case-sensitive but generally all-upper and all-lower are both accepted.

8.2 The graphical interfaces

The graphical interfaces allow the user to interact with the tempo2 outputs and fitting algorithms. The most commonly used plugin is plk which allows the user to view the residuals, delete points, re-fit, change the fitting parameters and carry out most proceedures needed for pulsar timing. There are other plugins to limit the existence of gravitational wave backgrounds, obtain structure functions to probe the interstellar medium, produce power-spectral estimates of the residuals and to simulate new data sets. More details can be found on the plugins page. The following figures give examples for some of the graphical interfaces.

Figure 8.1: Example of the plk (left) and fake (right) graphical interface

Figure 8.2: (left) Example of the basic graphical interface. (right) Example of the delays graphical interface.


Edit - History - Print - Recent Changes - Search
Page last modified on July 31, 2012, at 05:15 AM