ArrivalTime.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2009 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// psrchive/More/Timing/Pulsar/ArrivalTime.h
 
#ifndef __Pulsar_ArrivalTime_h
#define __Pulsar_ArrivalTime_h
 
#include "Pulsar/Config.h"
#include "Pulsar/Algorithm.h"
#include "Estimate.h"
#include "toa.h"
 
namespace Pulsar {
 
  class ProfileShiftEstimator;
  class ShiftEstimator;
  class Archive;
  class Integration;
  class Profile;
  class Flux;
 
 
  class ArrivalTime : public Algorithm {
 
  public:
 
    ArrivalTime ();
 
    ~ArrivalTime ();
 
    virtual void preprocess (Archive* archive);
 
    virtual void set_observation (const Archive*);
 
    virtual void set_standard (const Archive*);
 
    void set_shift_estimator (ShiftEstimator*);
 
    ShiftEstimator* get_shift_estimator () const;
 
    void set_format (Tempo::toa::Format);
 
    void set_format (const std::string&);
 
    void set_format_flags (const std::string&);
 
    void set_attributes (const std::vector< std::string >&);
 
    void set_extra_text (const std::string&);
 
    void set_skip_bad (bool flag) { skip_bad = flag; }
 
    void set_positive_shifts (bool flag) { positive_shifts = flag; }
 
    void get_toas (std::vector<Tempo::toa>&);
 
    std::string get_value (const std::string& key, const Tempo::toa&);
 
    void set_residual (Archive* res) { residual = res; }
 
    Archive* get_residual () { return residual; }
    
    void set_flux_estimator (Flux *);
 
    Flux* get_flux_estimator () const;
 
  protected:
 
    Reference::To<const Archive> observation;
 
    Reference::To<const Archive> standard;
 
    Reference::To<Archive> residual;
    
    Reference::To<ShiftEstimator> shift_estimator;
 
    Reference::To<Flux> flux_estimator;
 
    static Option<std::string> default_format;
 
    Tempo::toa::Format format;
 
    std::string format_flags;
 
    std::string extra_text;
 
    std::vector<std::string> attributes;
    unsigned toa_subint;
    unsigned toa_chan;
 
    bool skip_bad;
 
    bool positive_shifts {false};
 
    /*
      Perhaps Tempo::toa::Format should be a base class, such that
      each child of the class does its own formatting
    */
    std::string get_tempo2_aux_txt (const Tempo::toa&);
 
    /* Return the IPTA-specific tempo2 flags */
    std::string get_ipta_aux_txt (const Tempo::toa&);
 
    virtual void get_toas (unsigned subint, std::vector<Tempo::toa>& toas);
 
    virtual void dress_toas (unsigned subint, std::vector<Tempo::toa>& toas);
 
    Tempo::toa get_toa (Estimate<double>& shift,
                        const Pulsar::Integration*, unsigned ichan);
 
  private:
 
    void standard_update (unsigned ichan=0);
    void setup (const Integration* subint, unsigned ichan);
 
  };
 
}
 
#endif