VariableFaradayRotation.h

//-*-C++-*-
/***************************************************************************
 *
 *   Copyright (C) 2022 by Willem van Straten
 *   Licensed under the Academic Free License version 2.1
 *
 ***************************************************************************/
 
#ifndef __Pulsar_VariableFaradayRotation_h
#define __Pulsar_VariableFaradayRotation_h
 
#include "Pulsar/KnownVariableTransformation.h"
#include "Pulsar/Faraday.h"
 
namespace Pulsar {

  class VariableFaradayRotation : public KnownVariableTransformation
  {
    // ionospheric Faraday rotation transformation
    mutable Reference::To<Calibration::Faraday> iono_faraday;
 
    // ionospheric Faraday rotation measure
    double ionospheric_rotation_measure;
 
    // interstellar Faraday rotation transformation
    mutable Reference::To<Calibration::Faraday> ism_faraday;
 
    // interstellar Faraday rotation measure
    double interstellar_rotation_measure;
 
    mutable LabelledJones<double> transformation;
    mutable bool is_required;
    mutable std::string description;
    void build () const;
 
  public:
 
    VariableFaradayRotation ();
 
    LabelledJones<double> get_value () override;

    void set_ionospheric_rotation_measure (double);

    void set_interstellar_rotation_measure (double);

    const Calibration::Faraday* get_interstellar_rotation () const { return ism_faraday; }

    const Calibration::Faraday* get_ionospheric_rotation () const { return iono_faraday; }

    bool required () const; 

    std::string get_description () const;
 
  };
}
 
#endif