CalibratorParameter.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2012 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// psrchive/More/Plotting/Pulsar/CalibratorSpectrum.h
 
#ifndef __Pulsar_CalibratorParameter_h
#define __Pulsar_CalibratorParameter_h
 
#include "Pulsar/FrequencyPlot.h"
#include "Pulsar/Calibrator.h"
#include "Pulsar/Index.h"
 
#include "EstimatePlotter.h"
 
namespace Pulsar {

  class CalibratorParameter : public FrequencyPlot
  {
 
  public:

    CalibratorParameter ();

    TextInterface::Parser* get_interface ();

    std::string get_ylabel (const Archive*);

    void set_managed (bool flag=true) { managed = flag; }

    void prepare (const Archive*);

    void prepare (const Calibrator::Info*, const Archive*);

    void draw (const Archive*);

    void set_class (unsigned i) { iclass = i; }
    unsigned get_class () const { return iclass; }

    void set_outlier_threshold (float t) { outlier_threshold = t; }
    float get_outlier_threshold () const { return outlier_threshold; }

    void set_subint (const Index& isub) { subint = isub; }
    Index get_subint () const { return subint; }

    static Calibrator::Info* get_Info (const Archive*, Index subint,
                                       float outlier_threshold);
 
  protected:
 
    EstimatePlotter plotter;
 
    // Text interface to the CalibratorParameter class
    class Interface;
 
    // Calibrator info derived from the input archive
    Reference::To<const Calibrator::Info> info;
 
    // The index of the class of parameters to be plotted
    unsigned iclass;
 
    // Flag set to true when data are managed externally (disables prepare)
    bool managed;
 
    // Sub-integration from which to derive a solution
    Index subint;
    
    // Threshold used to detect outliers when creating a SingleAxis calibrator
    float outlier_threshold;
  };
 
}
 
#endif