Calibrator.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2003 - 2022 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// psrchive/Base/Classes/Pulsar/Calibrator.h
 
#ifndef __Calibrator_H
#define __Calibrator_H
 
#include "Pulsar/Config.h"
 
#include <vector>
 
#include "Estimate.h"
#include "Jones.h"
#include "MJD.h"
 
namespace Pulsar {
 
  class Archive;
  class Integration;
  class CalibratorExtension;

  class Calibrator : public Reference::Able
  {
    
  public:

    class Type;

    static unsigned verbose;

    static Pulsar::Option<float> median_smoothing;

    static Pulsar::Option<float> interpolating;

    static Pulsar::Option<float> det_threshold;

    Calibrator ();
    
    virtual ~Calibrator ();

    static unsigned get_instance_count ();

    virtual void calibrate (Archive* archive) = 0;

    virtual const Type* get_type () const;

    virtual unsigned get_nchan () const = 0;

    virtual float get_weight (unsigned ichan) const = 0;

    virtual CalibratorExtension* new_Extension () const = 0;

    Archive* new_solution (const std::string& archive_class) const;

    virtual MJD get_epoch () const;

    virtual std::string get_filenames () const;

    const Archive* get_Archive () const;

    bool has_Archive () const;

    class Info;


    virtual Info* get_Info () const { return 0; }
 
    template<class T>
    bool is_a () const
    {
      return dynamic_cast<const T*> (this) != 0;
    }

    class Variation : public Reference::Able
    {
    public:

      virtual bool update (const Integration*) = 0;
    };
    
  protected:

    Reference::To<Type> type;

    Reference::To<Variation> variation;
    void copy_variation (Calibrator*);
    void set_variation (Variation* var) { variation = var; }
    
    Reference::To<const CalibratorExtension> extension;

    std::vector<std::string> filenames;

    const Archive* get_calibrator () const;

    Archive* get_calibrator ();

    virtual void set_calibrator (const Archive* archive);

    bool has_calibrator () const;
 
  private:

    Reference::To<const Archive> calibrator;
 
  };
 

  class Calibrator::Info : public Reference::Able
  {
 
  public:

    virtual ~Info () {}

    virtual std::string get_title() const = 0;

    virtual unsigned get_nchan () const = 0;

    virtual unsigned get_nclass () const = 0;

    virtual std::string get_label (unsigned iclass) const = 0;

    virtual unsigned get_nparam (unsigned iclass) const = 0;

    virtual Estimate<float> get_param (unsigned ichan, unsigned iclass, unsigned iparam) const = 0;


    virtual std::string get_param_name (unsigned iparam) const { return ""; }

    
    virtual int get_colour_index (unsigned iclass, unsigned iparam) const
    { return iparam + 1; }
    
    virtual int get_graph_marker (unsigned iclass, unsigned iparam) const
    { return -1; }
    
    
  };
 
 
 
 
}
 
#endif