ReadPulsarParFile.h File Reference

Prototypes
void *	PulsarGetParam (const PulsarParameters *pars, const CHAR *name)
	Get the required parameter value from the PulsarParameters structure. More...
void *	PulsarGetParamErr (const PulsarParameters *pars, const CHAR *name)
	Get the required parameter error value from the PulsarParameters structure. More...
const UINT4 *	PulsarGetParamFitFlag (const PulsarParameters *pars, const CHAR *name)
	Get the fit flag array for a given parameter from the PulsarParameters structure. More...
const UINT4Vector *	PulsarGetParamFitFlagAsVector (const PulsarParameters *pars, const CHAR *name)
	Get the fit flag array for a given parameter from the PulsarParameters structure. More...
REAL8	PulsarGetREAL8ParamErr (const PulsarParameters *pars, const CHAR *name)
	Return a REAL8 parameter error value. More...
const REAL8Vector *	PulsarGetREAL8VectorParamErr (const PulsarParameters *pars, const CHAR *name)
	Return a REAL8Vector parameter error value. More...
REAL8	PulsarGetREAL8VectorParamErrIndividual (const PulsarParameters *pars, const CHAR *name)
	Return an individual REAL8 value from a REAL8Vector parameter. More...
PulsarParamType	PulsarGetParamType (const PulsarParameters *pars, const char *name)
	Get the required parameter's type. More...
REAL8	PulsarGetREAL8Param (const PulsarParameters *pars, const CHAR *name)
	Return a REAL8 parameter. More...
REAL8	PulsarGetREAL8ParamOrZero (const PulsarParameters *pars, const CHAR *name)
	Return a REAL8 parameter if it exists, otherwise return zero. More...
UINT4	PulsarGetUINT4Param (const PulsarParameters *pars, const CHAR *name)
	Return a UINT4 parameter. More...
UINT4	PulsarGetUINT4ParamOrZero (const PulsarParameters *pars, const CHAR *name)
	Return a UINT4 parameter if it exists, otherwise return zero. More...
const CHAR *	PulsarGetStringParam (const PulsarParameters *pars, const CHAR *name)
	Return a string parameter. More...
void	PulsarAddStringParam (PulsarParameters *pars, const CHAR *name, const CHAR *value)
	Add a string parameter to the PulsarParameters structure. More...
const REAL8Vector *	PulsarGetREAL8VectorParam (const PulsarParameters *pars, const CHAR *name)
	Return a REAL8Vector parameter. More...
void	PulsarAddREAL8VectorParam (PulsarParameters *pars, const CHAR *name, const REAL8Vector *value)
	Add a REAL8Vector parameter to the PulsarParameters structure. More...
REAL8	PulsarGetREAL8VectorParamIndividual (const PulsarParameters *pars, const CHAR *name)
	Return an individual REAL8 value from a REAL8Vector parameter. More...
void	PulsarAddParam (PulsarParameters *pars, const CHAR *name, void *value, PulsarParamType type)
	Add a parameter and value to the PulsarParameters structure. More...
void	PulsarAddREAL8Param (PulsarParameters *pars, const CHAR *name, REAL8 value)
	Add a REAL8 parameter to the PulsarParameters structure. More...
void	PulsarAddUINT4Param (PulsarParameters *pars, const CHAR *name, UINT4 value)
	Add a UINT4 parameter to the PulsarParameters structure. More...
void	PulsarClearParams (PulsarParameters *pars)
	Free all the parameters from a PulsarParameters structure. More...
void	PulsarRemoveParam (PulsarParameters *pars, const CHAR *name)
	Remove a given parameter from a PulsarParameters structure. More...
void	PulsarSetParam (PulsarParameters *pars, const CHAR *name, const void *value)
	Set the value of a parameter in the PulsarParameters structure. More...
void	PulsarSetParamErr (PulsarParameters *pars, const CHAR *name, void *value, const UINT4 *fitFlag, UINT4 len)
	Set the value of the error of a parameter in the PulsarParameters structure. More...
void	PulsarSetREAL8ParamErr (PulsarParameters *pars, const CHAR *name, REAL8 value, UINT4 fitFlag)
	Set the error value for a REAL8 parameter. More...
void	PulsarSetREAL8VectorParamErr (PulsarParameters *pars, const CHAR *name, const REAL8Vector *value, const UINT4 *fitFlag)
	Set the error values for a REAL8Vector parameter. More...
int	PulsarCheckParam (const PulsarParameters *pars, const CHAR *name)
	Check for the existence of the parameter name in the PulsarParameters structure. More...
void	PulsarFreeParams (PulsarParameters *par)
	Function to free memory from pulsar parameters. More...
void	PulsarCopyParams (PulsarParameters *origin, PulsarParameters *target)
	Function to copy a PulsarParameters structure. More...
void	ParConvToFloat (const CHAR *in, void *out)
	Conversion functions from units used in TEMPO parameter files into SI units. More...
void	ParConvToInt (const CHAR *in, void *out)
	Convert the input string into a unsigned integer number. More...
void	ParConvToString (const CHAR *in, void *out)
	Copy the input string into the output pointer. More...
void	ParConvDegsToRads (const CHAR *in, void *out)
	Convert the input string from degrees to radians. More...
void	ParConvMasPerYrToRadPerSec (const CHAR *in, void *out)
	Convert the input string from milliarcsecs per year to radians per second. More...
void	ParConvSecsToRads (const CHAR *in, void *out)
	Convert the input string from seconds to radians. More...
void	ParConvArcsecsToRads (const CHAR *in, void *out)
	Convert the input string from arcseconds to radians. More...
void	ParConvMasToRads (const CHAR *in, void *out)
	Convert the input string from milliarcsecs to radians. More...
void	ParConvInvArcsecsToInvRads (const CHAR *in, void *out)
	Convert the input string from 1/acrseconds to 1/radians. More...
void	ParConvDaysToSecs (const CHAR *in, void *out)
	Convert the input string from days to seconds. More...
void	ParConvKpcToMetres (const CHAR *in, void *out)
	Convert the input string from kiloparsecs to metres. More...
void	ParConvBinaryUnits (const CHAR *in, void *out)
	Convert the binary system parameter from a string to a double, but make the check (as performed by TEMPO2) that this is > 1e-7 then it's in units of 1e-12, so needs converting by that factor. More...
void	ParConvMJDToGPS (const CHAR *in, void *out)
	Convert the input string from a TT MJD value into a GPS time. More...
void	ParConvDegPerYrToRadPerSec (const CHAR *in, void *out)
	Convert the input string from degrees per year to radians per second. More...
void	ParConvSolarMassToKg (const CHAR *in, void *out)
	Convert the input string from solar masses to kilograms. More...
void	ParConvRAToRads (const CHAR *in, void *out)
	Convert a right ascension input string in the format "hh:mm:ss.s" into radians. More...
void	ParConvDecToRads (const CHAR *in, void *out)
	Convert a declination input string in the format "dd:mm:ss.s" into radians. More...
void	ParConvMicrosecToSec (const CHAR *in, void *out)
	Convert an input string from microseconds into seconds. More...
PulsarParameters *	XLALReadTEMPOParFile (const CHAR *pulsarAndPath)
	Read in the parameters from a TEMPO(2) parameter file into a PulsarParameters structure. More...
LALStringVector *	XLALReadTEMPOCorFile (REAL8Array *cormat, CHAR *corfile)
	This function will read in a TEMPO-style parameter correlation matrix. More...
void	PrintPulsarParameters (BinaryPulsarParams params)
	function to print out all the pulsar parameters read in from a par file More...
REAL8	XLALTTMJDtoGPS (REAL8 MJD)
	This function converts a MJD format time corrected to Terrestrial Time (TT) into an equivalent GPS time. More...
REAL8	XLALTDBMJDtoGPS (REAL8 MJD)
	If you have an MJD arrival time on the Earth then this will convert it to the equivalent GPS time in TDB (see Table 1 of Seidelmann and Fukushima, Astronomy & Astrophysics, 265, 833-838 (1992). More...
REAL8	XLALTCBMJDtoGPS (REAL8 MJD)
	If you have an MJD arrival time on the Earth then this will convert it to the equivalent GPS time in TCB (see Table 1 of Seidelmann and Fukushima, Astronomy & Astrophysics, 265, 833-838, 1992). More...

Go to the source code of this file.

Data Structures
struct	PulsarParam
	The PulsarParam list node structure. More...
struct	PulsarParameters
	The PulsarParameters structure to contain a set of pulsar parameters. More...
struct	BinaryPulsarParams
	A structure to contain all pulsar parameters and associated errors. More...

Macros
#define	PULSAR_HASHTABLE_SIZE   512
#define	PULSAR_PARNAME_MAX   128
#define	GPS0MJD   44244.0 /* start of GPS time (MJD 44244) */
#define	TDT_TAI   32.184
#define	GPS_TDT   (TDT_TAI + XLAL_EPOCH_GPS_TAI_UTC)
#define	LALPULSAR_TEMPO2_MTSUN_SI   4.925490947e-6 /* value of GMsun/c^3 used in TEMPO2 */
#define	LALPULSAR_TEMPO2_MSUN_SI   (LALPULSAR_TEMPO2_MTSUN_SI * LAL_MPL_SI / LAL_TPL_SI) /* derived value of Msun */
Error Codes
#define	READPULSARPARFILEH_ENULLOUTPUT   1
#define	READPULSARPARFILEH_MSGENULLOUTPUT   "Output was Null"

Enumerations
enum	PulsarParamType {   PULSARTYPE_UINT4_t = 0 , PULSARTYPE_REAL8_t , PULSARTYPE_REAL8Vector_t , PULSARTYPE_string_t ,   PULSARTYPE_void_ptr_t }
	An enumerated type for denoting the type of a variable. More...

Variables
size_t	PulsarTypeSize [5]