PolnCalibratorExtension.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2003-2009 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// psrchive/Base/Extensions/Pulsar/PolnCalibratorExtension.h
 
#ifndef __PolnCalibratorExtension_h
#define __PolnCalibratorExtension_h
 
#include "Pulsar/CalibratorExtension.h"
 
namespace Pulsar {
 
  class PolnCalibrator;

  
  class PolnCalibratorExtension : public CalibratorExtension {
    
  public:
    
    PolnCalibratorExtension ();

    PolnCalibratorExtension (const PolnCalibratorExtension&);

    const PolnCalibratorExtension& operator= (const PolnCalibratorExtension&);

    ~PolnCalibratorExtension ();

    PolnCalibratorExtension* clone () const
    { return new PolnCalibratorExtension( *this ); }

    TextInterface::Parser* get_interface();
 
    // Text interface to a PolnCalibratorExtension instance
    class Interface : public TextInterface::To<PolnCalibratorExtension>
    {
      public:
        Interface( PolnCalibratorExtension *s_instance = NULL );
    };

    PolnCalibratorExtension (const PolnCalibrator*);

    std::string get_short_name () const override { return "pcal"; }

    void set_type (const Calibrator::Type* type) override;

    void set_nchan (unsigned nchan) override;

    void remove_chan (unsigned first, unsigned last) override;

    void set_weight (unsigned ichan, float weight) override;
    float get_weight (unsigned ichan) const override;

    unsigned get_nparam () const;

    void set_ndim (unsigned);
    unsigned get_ndim () const;

    bool get_has_covariance () const;
    void set_has_covariance (bool);

    bool get_has_solver () const;
    void set_has_solver (bool);

    bool get_valid (unsigned ichan) const;
    void set_valid (unsigned ichan, bool valid);
 
    class Transformation;

    Transformation* get_transformation (unsigned c);
    const Transformation* get_transformation (unsigned c) const;

    void frequency_append (Archive* to, const Archive* from) override;
 
    void fscrunch (unsigned factor = 0);
    void fscrunch_to_nchan (unsigned new_nchan);
 
    Estimate<float> get_Estimate ( unsigned iparam, unsigned ichan ) const;
    void set_Estimate (unsigned iparam, unsigned ichan, const Estimate<float>&);
 
  protected:

    std::vector<Transformation> response;

    unsigned nparam = 0;

    unsigned ndim = 0;

    bool has_covariance = false;

    bool has_solver = false;

    void construct ();
 
  private:
    
    void init ();
 
  };
 
  class PolnCalibratorExtension::Transformation : public Reference::Able
  {
  public:

    Transformation ();

    unsigned get_nparam() const;
    void set_nparam (unsigned);

    std::string get_param_name (unsigned) const;
    void set_param_name (unsigned, const std::string&);

    std::string get_param_description (unsigned) const;
    void set_param_description (unsigned, const std::string&);

    double get_param (unsigned) const;
    void set_param (unsigned, double);

    double get_variance (unsigned) const;
    void set_variance (unsigned, double);

    std::vector< std::vector<double> > get_covariance () const;
    void set_covariance (const std::vector< std::vector<double> >&);

    void get_covariance (std::vector<double>&) const;
    void set_covariance (const std::vector<double>&);

    Estimate<double> get_Estimate (unsigned) const;
    void set_Estimate (unsigned, const Estimate<double>&);

    bool get_valid () const;
    void set_valid (bool);

    double get_chisq () const;
    void set_chisq (double);

    double get_log_det_curvature () const;
    void set_log_det_curvature (double);

    double get_log_cond_curvature () const;
    void set_log_cond_curvature (double);

    unsigned get_nfree() const;
    void set_nfree (unsigned);

    unsigned get_nfit() const;
    void set_nfit (unsigned);

    unsigned get_ndim() const;
    void set_ndim (unsigned);

    double get_reduced_chisq () const;

    double get_Akaike_information_criterion() const;

    double get_Bayesian_information_criterion() const;

    double get_geometric_information_criterion() const;

    double get_stochastic_information_complexity() const;
 
    // Text interface to a PolnCalibratorExtension instance
    class Interface : public TextInterface::To<Transformation>
    {
      public:
        Interface();
    };
 
  protected:
 
    std::vector< Estimate<double> > params;
    std::vector< std::string > names;
    std::vector< std::string > descriptions;
 
    std::vector<double> covariance;
    double chisq = 0.0;
    double log_det_curvature = 0.0;
    double log_cond_curvature = 0.0;
    unsigned nfree = 0;
    unsigned nfit = 0;

    unsigned ndim = 0;
    bool valid = false;
 
  };
 
}
 
#endif