ModeCoherency.h
1 //-*-C++-*-
2 /***************************************************************************
3  *
4  * Copyright (C) 2011 by Willem van Straten
5  * Licensed under the Academic Free License version 2.1
6  *
7  ***************************************************************************/
8 
9 // psrchive/More/MEAL/MEAL/ModeCoherency.h
10 
11 #ifndef __MEAL_ModeCoherency_H
12 #define __MEAL_ModeCoherency_H
13 
14 #include "MEAL/Coherency.h"
15 #include "MEAL/Wrap.h"
16 #include "Vector.h"
17 
18 namespace MEAL {
19 
20  class Scalar;
21  class ScalarParameter;
22  class BoostUnion;
23  class UnitTangent;
24 
26 
33  class ModeCoherency : public Wrap<Coherency>
34  {
35 
36  public:
37 
39  ModeCoherency ();
40 
42  ModeCoherency (const ModeCoherency& copy);
43 
45  ModeCoherency& operator = (const ModeCoherency& copy);
46 
48  ~ModeCoherency ();
49 
51  UnitTangent* get_axis ();
52 
54  void set_axis (UnitTangent*);
55 
57  Scalar* get_beta ();
58 
60  Scalar* get_intensity ();
61 
63  virtual void set_stokes (const Stokes<double>& stokes);
64 
66  virtual void set_stokes (const Stokes< Estimate<double> >& stokes);
67 
69  virtual Stokes< Estimate<double> > get_stokes () const;
70 
71  // ///////////////////////////////////////////////////////////////////
72  //
73  // Function implementation
74  //
75  // ///////////////////////////////////////////////////////////////////
76 
78  std::string get_name () const;
79 
80  protected:
81 
83  void init ();
84 
85  Reference::To<BoostUnion> boost;
86  Reference::To<UnitTangent> axis;
87  Reference::To<ScalarParameter> log_beta;
88  Reference::To<ScalarParameter> log_intensity;
89 
90  Reference::To<Scalar> beta;
91  Reference::To<Scalar> intensity;
92  };
93 
94 }
95 
96 #endif
MEAL::exp
const ScalarMath exp(const ScalarMath &x)
Return a ScalarMath instance representing exp(x)
Definition: ScalarMath.C:224
MEAL::ModeCoherency::get_intensity
Scalar * get_intensity()
Get the intensity.
Definition: ModeCoherency.C:105
MEAL::ScalarMath::get_expression
Scalar * get_expression() const
Access the expression.
Definition: ScalarMath.h:70
MEAL::ModeCoherency::get_stokes
virtual Stokes< Estimate< double > > get_stokes() const
Get the Stokes parameters and their estimated errors.
Definition: ModeCoherency.C:158
MEAL::ModeCoherency::~ModeCoherency
~ModeCoherency()
Destructor.
Definition: ModeCoherency.C:75
MEAL::Complex2
Pure virtual base class of all complex 2x2 matrix functions.
Definition: Complex2.h:34
MEAL::BoostUnion
Represents a boost (Hermitian, dichroic) transformation.
Definition: BoostUnion.h:29
MEAL::ModeCoherency::set_stokes
virtual void set_stokes(const Stokes< double > &stokes)
Set the Stokes parameters of the model.
Definition: ModeCoherency.C:111
MEAL::log
const ScalarMath log(const ScalarMath &x)
Return a ScalarMath instance representing log(x)
Definition: ScalarMath.C:232
MEAL::ScalarParameter::set_value_name
void set_value_name(const std::string &name)
Set the name of the parameter.
Definition: ScalarParameter.C:53
MEAL::sqrt
const ScalarMath sqrt(const ScalarMath &x)
Return a ScalarMath instance representing x^.5.
Definition: ScalarMath.C:151
MEAL::ModeCoherency::ModeCoherency
ModeCoherency()
Default constructor.
Definition: ModeCoherency.C:48
MEAL::ScalarParameter
Represents a scalar parameter, .
Definition: ScalarParameter.h:24
MEAL::ModeCoherency::get_name
std::string get_name() const
Return the name of the class.
Definition: ModeCoherency.C:80
MEAL
Namespace in which all modeling and calibration related code is declared.
Definition: ExampleComplex2.h:16
MEAL::ModeCoherency::operator=
ModeCoherency & operator=(const ModeCoherency &copy)
Assignment operator.
Definition: ModeCoherency.C:62
MEAL::ModeCoherency
A coherency matrix parameterized by a logarithmic gain times a boost.
Definition: ModeCoherency.h:38
MEAL::atanh
const ScalarMath atanh(const ScalarMath &x)
Return a ScalarMath instance representing atanh(x)
Definition: ScalarMath.C:240
MEAL::ModeCoherency::get_beta
Scalar * get_beta()
Get beta.
Definition: ModeCoherency.C:99
MEAL::ModeCoherency::set_axis
void set_axis(UnitTangent *)
Set the model of the unit vector.
Definition: ModeCoherency.C:92
MEAL::Scalar
Pure virtual base class of scalar functions.
Definition: Scalar.h:24
MEAL::Function::copy
virtual void copy(const Function *model)
Does the work for operator =.
Definition: Function.C:58
MEAL::ModeCoherency::get_axis
UnitTangent * get_axis()
Get the model of the unit vector.
Definition: ModeCoherency.C:86
MEAL::UnitTangent
Represents a unit vector in three-dimensional space.
Definition: UnitTangent.h:46
MEAL::ModeCoherency::init
void init()
Works for the constructors.
Definition: ModeCoherency.C:24
Generated using doxygen 1.8.17