Simulation/Pulsar/SimPolnTiming.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2005 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// psrchive/More/General/Pulsar/SimPolnTiming.h
 
#ifndef __Pulsar_SimPolnTiming_h
#define __Pulsar_SimPolnTiming_h
 
#include "Pulsar/PolnProfileFit.h"
#include "Pulsar/SyntheticPolnProfile.h"
#include "MEAL/RotatingVectorModel.h"
#include "MEAL/Gaussian.h"
 
#include <iostream>
 
namespace Pulsar {
 
  class Archive;
 
  class Range {
  public:
    Range (unsigned steps, double min, double max);
 
    unsigned steps;
    double min, max;
    unsigned start, stop;

    double get_value (unsigned current);

    void parse (const std::string& txt);
  };
 
  std::ostream& operator<< (std::ostream& ostr, const Range& r);

  class SimPolnTiming {
 
  public:

    SimPolnTiming ();

    ~SimPolnTiming ();

    SyntheticPolnProfile generate;

    PolnProfileFit fit;

    MEAL::Gaussian gaussian;

    MEAL::RotatingVectorModel rvm;

    unsigned nbin;

    void set_centre (double);

    float standard_noise;

    float rvm_beta;

    void set_standard (Archive*);

    unsigned iterations;

    float measurement_noise;

    float offset;

    bool vary_line_of_sight;

    Range slope;
    double poln_slope;

    Range width;
    double pulse_width;

    Range dgain;
    double diff_gain;

    Range parallactic;
    double parallactic_angle;

    Range boost_vector;
    double B_orientation;
    double B_ellipticity;
    double beta;

    void run_simulation ();

    std::string title;

    bool as_Estimate;

    std::ostream* output;
 
    bool logarithmic;
    void extrapolate_benefit (unsigned steps);
    void susceptibility ();

    void boost_around ();
 
  protected:
 
    class Result {
    public:
      Estimate<double> I_est_mean;
      Estimate<double> S_est_mean;
      Estimate<double> I_mean;
      Estimate<double> S_mean;
      Estimate<double> I_err;
      Estimate<double> S_err;
    };

    void one_loop (unsigned level);

    Result one_step ();

    Reference::To<Pulsar::Archive> archive;
 
  };
 
}
 
#endif