#include <lal/LALStdlib.h>
Include dependency graph for BinaryPulsarTiming.h:
This graph shows which files directly or indirectly include this file:
Go to the source code of this file.
Data Structures | |
| struct | tagBinaryPulsarParams |
| A structure to contain all pulsar parameters and associated errors. More... | |
| struct | tagBinaryPulsarInput |
| structure containing the input parameters for the binary delay function More... | |
| struct | tagBinaryPulsarOutput |
| structure containing the output parameters for the binary delay function More... | |
Defines | |
| #define | BINARYPULSARTIMINGH_ENULLINPUT 1 |
| #define | BINARYPULSARTIMINGH_ENULLOUTPUT 2 |
| #define | BINARYPULSARTIMINGH_ENULLPARAMS 3 |
| #define | BINARYPULSARTIMINGH_ENULLBINARYMODEL 4 |
| #define | BINARYPULSARTIMINGH_ENULLPULSARANDPATH 5 |
| #define | BINARYPULSARTIMINGH_EPARFILEERROR 6 |
| #define | BINARYPULSARTIMINGH_EFAIL 7 |
| #define | BINARYPULSARTIMINGH_ENAN 8 |
| #define | BINARYPULSARTIMINGH_EPARFAIL 9 |
| #define | BINARYPULSARTIMINGH_MSGENULLINPUT "Input was Null" |
| #define | BINARYPULSARTIMINGH_MSGENULLOUTPUT "Output was Null" |
| #define | BINARYPULSARTIMINGH_MSGENULLPARAMS "Params was Null" |
| #define | BINARYPULSARTIMINGH_MSGNULLBINARYMODEL "Binary model is Null or not specified - you should\not be in the binary timing routine" |
| #define | BINARYPULSARTIMINGH_MSGENULLPULSARANDPATH "Path to pulsar.par file not specified" |
| #define | BINARYPULSARTIMINGH_MSGEPARFILEERROR ".par file path is wrong or file doesn't exist" |
| #define | BINARYPULSARTIMINGH_MSGEFAIL "Time delay computation failed" |
| #define | BINARYPULSARTIMINGH_MSGENAN "Output is NaN!" |
| #define | BINARYPULSARTIMINGH_MSGEPARFAIL "Failed to read in .par file" |
Typedefs | |
| typedef tagBinaryPulsarParams | BinaryPulsarParams |
| A structure to contain all pulsar parameters and associated errors. | |
| typedef tagBinaryPulsarInput | BinaryPulsarInput |
| structure containing the input parameters for the binary delay function | |
| typedef tagBinaryPulsarOutput | BinaryPulsarOutput |
| structure containing the output parameters for the binary delay function | |
Functions | |
| NRCSID (BINARYPULSARTIMINGH,"$Id: BinaryPulsarTiming.h,v 1.13 2008/04/21 17:48:58 mpitkin Exp $") | |
| void | XLALBinaryPulsarDeltaT (BinaryPulsarOutput *output, BinaryPulsarInput *input, BinaryPulsarParams *params) |
| function to calculate the binary system delay | |
| void | LALBinaryPulsarDeltaT (LALStatus *status, BinaryPulsarOutput *output, BinaryPulsarInput *input, BinaryPulsarParams *params) |
Calculate the binary system time delay using the pulsar parameters in params. | |
| void | XLALReadTEMPOParFile (BinaryPulsarParams *output, CHAR *pulsarAndPath) |
| function to read in a TEMPO parameter file | |
| void | LALReadTEMPOParFile (LALStatus *status, BinaryPulsarParams *output, CHAR *pulsarAndPath) |
| REAL8 | LALDegsToRads (CHAR *degs, const CHAR *coords) |
| A function to convert RA and Dec in format dd:mm:ss.ss or ddmmss.ss into the number of degrees as a float degs is the string containing the dd/hh:mm:ss.sss coords is either ra/RA or dec/DEC. | |
| REAL8 | LALTTMJDtoGPS (REAL8 MJD) |
Functions for converting times given in Terrestrial time TT, TDB, or TCB in MJD to times in GPS - this is important for epochs given in .par files which are in TDB(MJD). | |
| REAL8 | LALTDBMJDtoGPS (REAL8 MJD) |
| REAL8 | LALTCBMJDtoGPS (REAL8 MJD) |
| void | PrintPulsarParameters (BinaryPulsarParams params) |
| function to print out all the pulsar parameters read in from a par file | |
The main function in this code - XLALBinaryPulsarDeltaT - is for calculating the time delay on a pulsar signal caused by its orbit within a binary system. It tranforms a signal from the binary system barycentre to the pulsar proper time. It is equivalent to the LALBarycenter() functions for transforming the Earth reference frame to the solar system barycentre. It copies the functions from the standard pulsar timing software TEMPO and can use the various binary system models BT, BT1P, BT2P, BTX, ELL1, DD and MSS.
Included is a function to read in a set of pulsar parameters from a standard TEMPO parameter (.par) file - XLALReadTEMPOParFile.
Also included are function to convert times given in the TT, TDB or TCB frames (given as a modified Julian Date - MJD) into a GPS time.
Definition in file BinaryPulsarTiming.h.
| #define BINARYPULSARTIMINGH_ENULLINPUT 1 |
Definition at line 90 of file BinaryPulsarTiming.h.
| #define BINARYPULSARTIMINGH_ENULLOUTPUT 2 |
Definition at line 91 of file BinaryPulsarTiming.h.
| #define BINARYPULSARTIMINGH_ENULLPARAMS 3 |
Definition at line 92 of file BinaryPulsarTiming.h.
| #define BINARYPULSARTIMINGH_ENULLBINARYMODEL 4 |
Definition at line 93 of file BinaryPulsarTiming.h.
| #define BINARYPULSARTIMINGH_ENULLPULSARANDPATH 5 |
Definition at line 94 of file BinaryPulsarTiming.h.
| #define BINARYPULSARTIMINGH_EPARFILEERROR 6 |
Definition at line 95 of file BinaryPulsarTiming.h.
| #define BINARYPULSARTIMINGH_EFAIL 7 |
Definition at line 96 of file BinaryPulsarTiming.h.
| #define BINARYPULSARTIMINGH_ENAN 8 |
Definition at line 97 of file BinaryPulsarTiming.h.
| #define BINARYPULSARTIMINGH_EPARFAIL 9 |
Definition at line 98 of file BinaryPulsarTiming.h.
| #define BINARYPULSARTIMINGH_MSGENULLINPUT "Input was Null" |
Definition at line 100 of file BinaryPulsarTiming.h.
| #define BINARYPULSARTIMINGH_MSGENULLOUTPUT "Output was Null" |
Definition at line 101 of file BinaryPulsarTiming.h.
| #define BINARYPULSARTIMINGH_MSGENULLPARAMS "Params was Null" |
Definition at line 102 of file BinaryPulsarTiming.h.
| #define BINARYPULSARTIMINGH_MSGNULLBINARYMODEL "Binary model is Null or not specified - you should\not be in the binary timing routine" |
Definition at line 103 of file BinaryPulsarTiming.h.
| #define BINARYPULSARTIMINGH_MSGENULLPULSARANDPATH "Path to pulsar.par file not specified" |
Definition at line 105 of file BinaryPulsarTiming.h.
| #define BINARYPULSARTIMINGH_MSGEPARFILEERROR ".par file path is wrong or file doesn't exist" |
Definition at line 106 of file BinaryPulsarTiming.h.
| #define BINARYPULSARTIMINGH_MSGEFAIL "Time delay computation failed" |
Definition at line 107 of file BinaryPulsarTiming.h.
| #define BINARYPULSARTIMINGH_MSGENAN "Output is NaN!" |
Definition at line 108 of file BinaryPulsarTiming.h.
| #define BINARYPULSARTIMINGH_MSGEPARFAIL "Failed to read in .par file" |
Definition at line 109 of file BinaryPulsarTiming.h.
| typedef struct tagBinaryPulsarParams BinaryPulsarParams |
A structure to contain all pulsar parameters and associated errors.
| typedef struct tagBinaryPulsarInput BinaryPulsarInput |
structure containing the input parameters for the binary delay function
| typedef struct tagBinaryPulsarOutput BinaryPulsarOutput |
structure containing the output parameters for the binary delay function
| NRCSID | ( | BINARYPULSARTIMINGH | , | |
| "$Id: BinaryPulsarTiming. | h, | |||
| v 1.13 2008/04/21 17:48:58 mpitkin Exp $" | ||||
| ) |
| void XLALBinaryPulsarDeltaT | ( | BinaryPulsarOutput * | output, | |
| BinaryPulsarInput * | input, | |||
| BinaryPulsarParams * | params | |||
| ) |
| void LALBinaryPulsarDeltaT | ( | LALStatus * | status, | |
| BinaryPulsarOutput * | output, | |||
| BinaryPulsarInput * | input, | |||
| BinaryPulsarParams * | params | |||
| ) |
Calculate the binary system time delay using the pulsar parameters in params.
Definition at line 122 of file BinaryPulsarTiming.c.
| void XLALReadTEMPOParFile | ( | BinaryPulsarParams * | output, | |
| CHAR * | pulsarAndPath | |||
| ) |
| void LALReadTEMPOParFile | ( | LALStatus * | status, | |
| BinaryPulsarParams * | output, | |||
| CHAR * | pulsarAndPath | |||
| ) |
Definition at line 608 of file BinaryPulsarTiming.c.
A function to convert RA and Dec in format dd:mm:ss.ss or ddmmss.ss into the number of degrees as a float degs is the string containing the dd/hh:mm:ss.sss coords is either ra/RA or dec/DEC.
Definition at line 1629 of file BinaryPulsarTiming.c.
Functions for converting times given in Terrestrial time TT, TDB, or TCB in MJD to times in GPS - this is important for epochs given in .par files which are in TDB(MJD).
TT and GPS are different by a factor of 51.184 secs, this is just the historical factor of 32.184 secs between TT and TAI (International Atomic Time) and the other 19 seconds come from the leap seonds added between the TAI and UTC up to the point of definition of GPS time at UTC 01/01/1980.
Definition at line 1730 of file BinaryPulsarTiming.c.
Definition at line 1746 of file BinaryPulsarTiming.c.
Definition at line 1777 of file BinaryPulsarTiming.c.
| void PrintPulsarParameters | ( | BinaryPulsarParams | params | ) |
function to print out all the pulsar parameters read in from a par file
Definition at line 1569 of file BinaryPulsarTiming.c.
1.5.2