CalibratorStokes.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2003 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// psrchive/Base/Extensions/Pulsar/CalibratorStokes.h
 
#ifndef __CalibratorStokes_h
#define __CalibratorStokes_h
 
#include "Pulsar/HasChannels.h"
#include "Stokes.h"
#include "Estimate.h"
 
namespace Pulsar {
  

  class CalibratorStokes : public HasChannels {
    
  public:

    enum CouplingPoint
    {
     BeforeProjection, // e.g. satellite-borne
     BeforeBasis,      // e.g. radiated onto primary reflector
     BeforeFrontend,   // e.g. radiated into feedhorn
     BeforeIdeal,      // e.g. coupled after transducer
     BeforeBackend,    // not sure why
     Unknown           // don't know
    };
    
    CalibratorStokes ();

    CalibratorStokes (const CalibratorStokes& extension);

    const CalibratorStokes& operator= (const CalibratorStokes& extension);

    ~CalibratorStokes ();

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

    TextInterface::Parser* get_interface();

    class Interface;

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

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

    void set_coupling_point (CouplingPoint);
    CouplingPoint get_coupling_point () const;

    void remove_chan (unsigned first, unsigned last);

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

    void set_stokes (unsigned ichan, const Stokes< Estimate<float> >& stokes);
    Stokes< Estimate<float> > get_stokes (unsigned ichan) const;
 
    unsigned get_nparam () const { return 3; /* Stokes Q,U,V */ }
    Estimate<float> get_Estimate ( unsigned iparam, unsigned ichan ) const;
    void set_Estimate (unsigned iparam, unsigned ichan, Estimate<float>&);
    void set_value (unsigned iparam, unsigned ichan, double val);
    void set_variance (unsigned iparam, unsigned ichan, double var);

    void frequency_append (Archive* to, const Archive* from);
 
  protected:


    CouplingPoint coupling_point;
    

    std::vector< Stokes< Estimate<float> > > stokes;

    void range_check (unsigned ichan, const char* method) const;
 
    friend class CalibratorStokes::Interface;
 
    // Internal convenience interface to the Stokes polarization vector data
    class PolnVector;

    PolnVector* get_poln (unsigned ichan);
 
    Reference::To<PolnVector> current;
  };
 
  std::ostream& operator << (std::ostream& ostr,
                             CalibratorStokes::CouplingPoint);
  std::istream& operator >> (std::istream& is,
                             CalibratorStokes::CouplingPoint&);
 
}
 
#endif