ProjectionCorrection.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2008 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
// psrchive/More/Polarimetry/Pulsar/ProjectionCorrection.h
 
#ifndef __Pulsar_ProjectionCorrection_H
#define __Pulsar_ProjectionCorrection_H
 
#include "Pulsar/Parallactic.h"
#include "Reference.h"
#include "Jones.h"
 
class MountProjection;
 
namespace Pulsar
{
  class Archive;
  class Receiver;
  class Telescope;
  class Integration;
  class Pointing;

  /*
    The projection consists of two parts:
 
    - J_antenna - projection from the sky to the antenna basis (e.g. Earth + mechanical rotation)
    - J_feed    - projection from the anntenna basis to the feed horn basis (e.g. feed rotation)
 
    If the Mount is of type MountProjection that computes its own projection transformation,
    then both J_antenna will be equal to the transformation returned by this object.
    Otherwise, J_antenna is a rotation about the line of sight by the parallactic angle.
 
    J_feed is a rotation about the line of sight by the feed angle.
 
    If one were to model the optics of the antenna (e.g. beam squint) then this
    transformation should be placed between J_antenna and J_feed; i.e.
 
    J_total = J_feed * J_optics * J_antenna
 
  */
  class ProjectionCorrection : public Reference::Able
  {
  public:

    static bool trust_pointing_para_angle;

    static bool trust_pointing_feed_angle;

    ProjectionCorrection ();
    ~ProjectionCorrection ();

    void set_archive (const Archive*);


    Jones<double> operator () (unsigned isub) const;

    bool required (unsigned isub) const;

    /* \pre The required method must be called before calling this method*/
    Jones<double> get_feed_projection () const;

    /* \pre The required method must be called before calling this method*/
    Jones<double> get_antenna_projection () const;

    Mount* get_mount ();
    
    std::string get_summary () const;

    std::string get_short_summary () const;

    void reset_summary () { summary = short_summary = ""; }
 
  protected:

    /* \pre The required method must be called before calling this method*/
    Jones<double> get_antenna_rotation () const;

    /* \pre The required method must be called before calling this method*/
    Jones<double> get_mount_projection () const;


    Reference::To<const Archive, false> archive;

    Reference::To<const Telescope, false> telescope;
    
    Reference::To<const Receiver, false> receiver;

    mutable Reference::To<const Integration, false> integration;

    mutable Reference::To<const Pointing, false> pointing;

    mutable Calibration::Parallactic para;
    
    mutable bool should_correct_vertical;

    mutable Reference::To<MountProjection> projection;

    mutable Reference::To<Mount> mount;

    mutable bool should_correct_projection;

    mutable bool must_correct_platform;

    mutable std::string summary;

    mutable std::string short_summary;
 
  };
}
 
#endif