ConfigurableProjectionExtension.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2022 - 2023 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// psrchive/Base/Extensions/Pulsar/ConfigurableProjectionExtension.h
 
#ifndef __ConfigurableProjectionExtension_h
#define __ConfigurableProjectionExtension_h
 
#include "Pulsar/HasChannels.h"
 
namespace Pulsar {
 
  class ConfigurableProjection;


 
  class ConfigurableProjectionExtension : public HasChannels
  {
    
  public:
    
    ConfigurableProjectionExtension ();

    ConfigurableProjectionExtension (const ConfigurableProjectionExtension&);

    const ConfigurableProjectionExtension& operator= (const ConfigurableProjectionExtension&);

    ~ConfigurableProjectionExtension ();

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

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

    ConfigurableProjectionExtension (const ConfigurableProjection*);

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

    void set_configuration (const std::string& text) { configuration = text; }
    const std::string& get_configuration () const { return configuration; }

    void set_nchan (unsigned nchan);
    unsigned get_nchan () const;

    void remove_chan (unsigned first, unsigned last);

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

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

    bool get_has_covariance () const;
    void set_has_covariance (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);
 
    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::string configuration;

    std::vector<Transformation> response;

    unsigned nparam;

    bool has_covariance;

    void construct ();
 
    void range_check (unsigned ichan, const char* method) const;
 
  private:
    
    void init ();
 
  };
 
  class ConfigurableProjectionExtension::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);
 
    // Text interface to a ConfigurableProjectionExtension 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;
    bool valid;
 
  };
 
}
 
#endif