/**
* \brief Automatically set the solar system ephemeris file based on environment variables and data time span
*
* This function will attempt to construct the file name for Sun, Earth and time correction ephemeris files
* based on the ephemeris used for the equivalent TEMPO(2) pulsar timing information. It assumes that the
* ephemeris files are those constructed between 2000 and 2020. The path to the file is not required as this
* will be found in \c XLALInitBarycenter.
*
* \param efile [in] a string that will return the Earth ephemeris file
* \param sfile [in] a string that will return the Sun ephemeris file
* \param tfile [in] a string that will return the time correction file
* \param pulsar [in] the pulsar parameters read from a .par file
* \param gpsstart [in] the GPS time of the start of the data
* \param gpsend [in] the GPS time of the end of the data
*
* \return The TimeCorrectionType e.g. TDB or TCB
*/
TimeCorrectionType XLALAutoSetEphemerisFiles( CHAR **efile, CHAR **sfile, CHAR **tfile, PulsarParameters *pulsar,
INT4 gpsstart, INT4 gpsend ){
/* set the times that the ephemeris files span */
INT4 ephemstart = 630720013; /* GPS time of Jan 1, 2000, 00:00:00 UTC */
INT4 ephemend = 1261872015; /* GPS time of Jan 1, 2020, 00:00:00 UTC */
TimeCorrectionType ttype = TIMECORRECTION_NONE;
if( gpsstart < ephemstart || gpsend < ephemstart || gpsstart > ephemend || gpsend > ephemend ){
XLAL_ERROR(XLAL_EFUNC, "Start and end times are outside the ephemeris file ranges!" );
}
*efile = XLALStringDuplicate("earth00-19-");
*sfile = XLALStringDuplicate("sun00-19-");
if( !PulsarCheckParam(pulsar, "EPHEM") ){
/* default to use DE405 */
*efile = XLALStringAppend(*efile, "DE405");
*sfile = XLALStringAppend(*sfile, "DE405");
}
else{
if( !strcmp(PulsarGetStringParam(pulsar, "EPHEM"), "DE405") || !strcmp(PulsarGetStringParam(pulsar, "EPHEM"), "DE200") ||
!strcmp(PulsarGetStringParam(pulsar, "EPHEM"), "DE414") || !strcmp(PulsarGetStringParam(pulsar, "EPHEM"), "DE421") ){
*efile = XLALStringAppend(*efile, PulsarGetStringParam(pulsar, "EPHEM"));
*sfile = XLALStringAppend(*sfile, PulsarGetStringParam(pulsar, "EPHEM"));
}
else{
XLAL_ERROR(XLAL_EFUNC, "Unknown ephemeris %s in par file.", PulsarGetStringParam(pulsar, "EPHEM") );
}
}
/* add .dat.gz extension */
*efile = XLALStringAppend(*efile, ".dat.gz");
*sfile = XLALStringAppend(*sfile, ".dat.gz");
if( !PulsarCheckParam( pulsar, "UNITS" ) ){
/* default to using TCB units */
*tfile = XLALStringDuplicate("te405_2000-2019.dat.gz");
ttype = TIMECORRECTION_TCB;
}
else{
if ( !strcmp( PulsarGetStringParam(pulsar, "UNITS"), "TDB" ) ){
*tfile = XLALStringDuplicate("tdb_2000-2019.dat.gz");
ttype = TIMECORRECTION_TDB;
}
else if ( !strcmp( PulsarGetStringParam(pulsar, "UNITS"), "TCB" ) ) {
*tfile = XLALStringDuplicate("te405_2000-2019.dat.gz");
ttype = TIMECORRECTION_TCB;
}
else{
XLAL_ERROR(XLAL_EFUNC, "Error... unknown units %s in par file!", PulsarGetStringParam(pulsar, "UNITS"));
}
}
return ttype;
}
int main( void ){
INT4 i = 0;
PulsarParameters *pars = NULL;
/* output par file */
FILE *fp = NULL;
if ( (fp = fopen(PARFILE, "w")) == NULL ){
XLAL_ERROR( XLAL_EIO, "Error... problem writing parfile!\n" );
}
for( i=0; i<NUMPARS; i++ ){
if ( p[i].sigma != NULL ){ /* write out value and error */
fprintf(fp, "%s\t%s\t%s\t%s\n", p[i].name, p[i].val, p[i].fitFlag, p[i].sigma);
}
else{ /* just write out value */
fprintf(fp, "%s\t%s\n", p[i].name, p[i].val);
}
}
fclose(fp);
/* read in par file */
pars = XLALReadTEMPOParFileNew( PARFILE );
/* check read-in parameters against originals */
for ( i=0; i<NUMPARS; i++ ){
CHAR outval[256];
CHAR outsigma[256];
CHAR outfitflag[256];
/* see if the parameter can be split into an alphabet and numerical value (as is the case
* for e.g. FB, which is held as a vector */
CHAR *namecopy = NULL, *token = NULL;
namecopy = XLALStringDuplicate( p[i].name );
token = strtok(namecopy, delimiters); /* get part of the name before the numerical delimiter */
if ( !PulsarCheckParam( pars, p[i].name ) && !PulsarCheckParam( pars, token ) ){
XLAL_ERROR( XLAL_EFAILED, "Error... parameter %s does not exist in the read-in data!\n", p[i].name );
}
/* value is a vector */
if ( PulsarCheckParam( pars, token ) && PulsarGetParamType( pars, token ) == PULSARTYPE_REAL8Vector_t ){
/* get value and convert to string */
if ( !strchr( p[i].valcheck, 'e' ) ){ /* number doesn't contain an exponent */
sprintf(outval, "%.5lf", PulsarGetREAL8VectorParamIndividual(pars, p[i].name));
}
else{ /* number does contain an exponent */
sprintf(outval, "%.5le", PulsarGetREAL8VectorParamIndividual(pars, p[i].name));
}
if ( p[i].sigmacheck != NULL ){
/* get error and convert to string */
if ( !strchr( p[i].sigmacheck, 'e' ) ){ /* number doesn't contain an exponent */
sprintf(outsigma, "%.5lf", PulsarGetREAL8VectorParamErrIndividual(pars, p[i].name));
}
else{
sprintf(outsigma, "%.5le", PulsarGetREAL8VectorParamErrIndividual(pars, p[i].name));
}
UINT4 *fitFlag = PulsarGetParamFitFlag(pars, token);
if ( fitFlag[atoi(p[i].name+strlen(token))] == 1 ){ sprintf(outfitflag, "1"); }
else if ( fitFlag[atoi(p[i].name+strlen(token))] == 0 ){ sprintf(outfitflag, " "); }
else {
XLAL_ERROR( XLAL_EFAILED, "Error... fit flag incorrect for %s.\n", p[i].name );
}
}
}
/* value is a double */
else if( PulsarGetParamType( pars, p[i].name ) == PULSARTYPE_REAL8_t ){
/* get value and convert to string */
if ( !strchr( p[i].valcheck, 'e' ) ){ /* number doesn't contain an exponent */
sprintf(outval, "%.5lf", PulsarGetREAL8Param(pars, p[i].name));
}
else{ /* number does contain an exponent */
sprintf(outval, "%.5le", PulsarGetREAL8Param(pars, p[i].name));
}
if ( p[i].sigmacheck != NULL ){
/* get error and convert to string */
if ( !strchr( p[i].sigmacheck, 'e' ) ){ /* number doesn't contain an exponent */
sprintf(outsigma, "%.5lf", PulsarGetREAL8ParamErr(pars, p[i].name));
}
else{
sprintf(outsigma, "%.5le", PulsarGetREAL8ParamErr(pars, p[i].name));
}
UINT4 *fitFlag = PulsarGetParamFitFlag(pars, p[i].name);
if ( fitFlag[0] == 1 ){ sprintf(outfitflag, "1"); }
else if ( fitFlag[0] == 0 ){ sprintf(outfitflag, " "); }
else {
XLAL_ERROR( XLAL_EFAILED, "Error... fit flag incorrect for %s.\n", p[i].name );
}
}
}
/* value is a string */
else if ( PulsarGetParamType( pars, p[i].name ) == PULSARTYPE_string_t ) {
CHAR *out = XLALStringDuplicate(PulsarGetStringParam(pars, p[i].name));
sprintf(outval, "%s", out);
XLALFree(out);
}
/* compare returned value with input value */
if ( strcmp(outval, p[i].valcheck) != 0 ){
XLAL_ERROR( XLAL_EFAILED, "Error... parameter %s does not match input (%s cf. %s)!\n", p[i].name, outval,
p[i].valcheck );
}
if( p[i].sigma != NULL ){
/* compare returned value with input value */
if ( strcmp(outsigma, p[i].sigmacheck) != 0 ){
XLAL_ERROR( XLAL_EFAILED, "Error... parameter sigma %s does not match input (%s cf. %s)!\n", p[i].name,
outsigma, p[i].sigmacheck );
}
if ( strcmp(outfitflag, p[i].fitFlag) != 0 ){
XLAL_ERROR( XLAL_EFAILED, "Error... parameter %s fit flag does not match input!\n", p[i].fitFlag );
}
}
XLALFree( namecopy );
}
/* remove par file */
if ( remove(PARFILE) != 0 ){
XLAL_ERROR( XLAL_EIO, "Error... problem removing parfile!\n" );
}
fprintf(stderr, "Successfully read in .par file values!\n");
PulsarFreeParams( pars );
LALCheckMemoryLeaks();
return XLAL_SUCCESS;
}
