sza::antenna::control::Refraction Class Reference

Class to encapsulate refraction corrections. More...

#include <carma/antenna/sza/antenna/control/Refraction.h>

Public Types
enum	Mode { OPTICAL, RADIO }
	Enumerate valid refraction models. More...

Public Member Functions
double	apply (PointingCorrections *f)
	Apply the refraction correction to the pointing corrections. More...
double	getA ()
	Return the A coefficient of the above equation. More...
double	getB ()
	Return the B coefficient of the above equation. More...
bool	isUsable ()
	Method to query if this refraction correction is usable. More...
void	pack (signed *s_elements)
	Method to pack our refraction coefficients in a format suitable for writing to the register database. More...
	Refraction ()
	Constructor. More...
void	reset ()
	Reset internal data members to something sensible. More...
void	setA (double a)
	Set the A coefficient of the above equation. More...
void	setB (double b)
	Set the B coefficient of the above equation. More...
void	setUsable (bool usable)
	Method to set the usable status of this correction. More...

Detailed Description

Class to encapsulate refraction corrections.

The standard approximation for atmospheric refraction is:

vac = obs - (A.cot(obs) + B.cot(obs)^3)

where vac is the elevation of the source as would be seen if there were no atmosphere, and obs is the elevation after refraction. Updates of the A and B terms are periodically received from the weather-station and recorded in an object of the following type.

Definition at line 34 of file Refraction.h.

Member Enumeration Documentation

enum sza::antenna::control::Refraction::Mode

Enumerate valid refraction models.

Definition at line 41 of file Refraction.h.

Constructor & Destructor Documentation

sza::antenna::control::Refraction::Refraction

(

)

Constructor.

Member Function Documentation

double sza::antenna::control::Refraction::apply

(

PointingCorrections *

f

)

Apply the refraction correction to the pointing corrections.

double sza::antenna::control::Refraction::getA

(

)

Return the A coefficient of the above equation.

Definition at line 80 of file Refraction.h.

double sza::antenna::control::Refraction::getB

(

)

Return the B coefficient of the above equation.

Definition at line 94 of file Refraction.h.

bool sza::antenna::control::Refraction::isUsable

(

)

Method to query if this refraction correction is usable.

Definition at line 59 of file Refraction.h.

void sza::antenna::control::Refraction::pack

(

signed *

s_elements

)

Method to pack our refraction coefficients in a format suitable for writing to the register database.

void sza::antenna::control::Refraction::reset

(

)

Reset internal data members to something sensible.

void sza::antenna::control::Refraction::setA

(

double

a

)

Set the A coefficient of the above equation.

Definition at line 73 of file Refraction.h.

void sza::antenna::control::Refraction::setB

(

double

b

)

Set the B coefficient of the above equation.

Definition at line 87 of file Refraction.h.

void sza::antenna::control::Refraction::setUsable

(

bool

usable

)

Method to set the usable status of this correction.

Definition at line 66 of file Refraction.h.

---

The documentation for this class was generated from the following file:

• carma/antenna/sza/antenna/control/Refraction.h