Instrument.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2004 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// psrchive/More/Polarimetry/Pulsar/Instrument.h
 
#ifndef __CalibrationInstrument_H
#define __CalibrationInstrument_H
 
#include "Pulsar/BackendFeed.h"
#include "Pulsar/HasOrientation.h"
#include "MEAL/ScalarParameter.h"
#include "MEAL/ChainRule.h"
 
namespace Calibration {
 
  class Feed;


  class Instrument : public BackendFeed, public HasOrientation
  {
 
  public:

    Instrument ();

    Instrument (const Instrument& s);

    const Instrument& operator = (const Instrument& s);

    Instrument* clone () const;

    ~Instrument ();

    void equal_ellipticities ();

    void independent_ellipticities ();

    MEAL::ScalarParameter* get_ellipticities () { return ellipticities; }

    bool has_equal_ellipticities () const { return ellipticities; }

    void equal_orientations ();
    void independent_orientations ();

    void set_cyclic (bool flag = true);

    void set_constant_orientation (bool);
    
    Estimate<double> get_orientation (unsigned ireceptor) const;

    Estimate<double> get_ellipticity (unsigned ireceptor) const;

    unsigned get_ellipticity_index (unsigned receptor) const;

    void set_orientation (unsigned ireceptor, const Estimate<double>& theta);

    void set_ellipticity (unsigned ireceptor, const Estimate<double>& chi);

    const Feed* get_feed () const;
    Feed* get_feed ();
 
    // ///////////////////////////////////////////////////////////////////
    //
    // HasOrientation implementation
    //
    // ///////////////////////////////////////////////////////////////////

    Estimate<double> get_orientation () const override;

    void offset_orientation (double delta_rad) override;
 
    // ///////////////////////////////////////////////////////////////////
    //
    // Model implementation
    //
    // ///////////////////////////////////////////////////////////////////

    std::string get_name () const;
 
  protected:

    Reference::To<Feed> feed;

    Reference::To< MEAL::ChainRule<MEAL::Complex2> > feed_chain;

    Reference::To<MEAL::ScalarParameter> ellipticities;

    Reference::To<MEAL::ScalarParameter> orientations;
 
  private:

    void init ();
 
  };
 
}
 
#endif