residual.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 1999 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// psrchive/Util/tempo/residual.h
 
#ifndef __RESIDUAL_H
#define __RESIDUAL_H
 
#include <vector>
 
namespace Tempo {
 
  // values output by TEMPO (resid2.tmp)
  class residual {
 
  public:
    static bool verbose;
 
    bool valid;         // is this a valid residual?
 
    double mjd;         // --TOA (MJD, referenced to solar system barycenter)
    double turns;       // --Postfit residual (pulse phase, from 0 to 1)
    double time;        // --Postfit residual (micro-seconds)
    double binaryphase; // --Orbital phase (where applicable)
    double obsfreq;     // --Observing frequency (in barycenter frame)
    double weight;      // --Weight of point in the fit
    double error;       // --Timing uncertainty (according to input file)
    double preres;      // --Prefit residual (micro-seconds)
 
    // returns day of year from mjd
    double dayofyear () const;
 
    // return UTC year, eg. 1995.67
    double utcyear () const;
 
    residual () { init(); };
    residual (int lun);
    ~residual () { };
    
    void init ();
 
    // Construct from a FORTRAN logical unit number 
    // (must be open and ready for reading)
    int  load (int lun);
    
    // place a vector load function in the residual namespace
    static int load (int r2flun, char* filename, 
                     std::vector<residual>* residuals);
  };
 
}
 
// given MJD returns UTC day-of-year as year.fracyear
double UTCdoy (double mjd);
 
#endif