Arroyo::phase_covariance< precision, circular_aperture > Class Template Reference

#include <covariance.h>

Inheritance diagram for Arroyo::phase_covariance< precision, circular_aperture >:

List of all members.

Public Member Functions
	phase_covariance ()
	phase_covariance (const emitter &emtr1, const emitter &emtr2, const refractive_atmospheric_model &ref_atm_model, const circular_aperture &circ_ap)
	~phase_covariance ()
	phase_covariance (const phase_covariance &pcv)
	phase_covariance (const char *filename)
	phase_covariance (const iofits &iof)
phase_covariance &	operator= (const phase_covariance &pcv)
void	read (const char *filename)
void	read (const Arroyo::iofits &iof)
void	write (const char *filename) const
void	write (Arroyo::iofits &iof) const
void	print (std::ostream &os, const char *prefix="") const
const refractive_atmospheric_model &	get_model () const
circular_aperture	get_aperture () const
const emitter &	get_first_emitter () const
const emitter &	get_second_emitter () const
double	aperture_averaged_variance (double wavelength_meters, int nsteps_in_integration) const
double	variance (double wavelength_meters, int nsteps_in_integration, const three_point &tp) const
pixel_array< precision >	variance (double pixel_scale_meters, double wavelength_meters, int nsteps_in_integration) const
double	covariance (double wavelength_meters, int nsteps_in_integration, const three_point &tp1, const three_point &tp2) const
pixel_array< precision >	covariance (double pixel_scale_meters, double wavelength_meters, int nsteps_in_integration, const three_point &tp, bool first_arg=true) const
pixel_array< precision >	covariance (double pixel_scale_meters, double wavelength_meters, int nsteps_in_integration, int xindex, int yindex, bool first_arg=true) const
Protected Member Functions
void	initialize_integration (int nsteps_in_integration) const
void	initialize_pixel_scale (double pixel_scale_meters) const
Protected Attributes
refractive_atmospheric_model	ref_atm_model
circular_aperture	circ_ap
double	pixel_scale_meters
int	nsteps_in_integration
pixel_array< precision >	stored_caliph_A
pixel_array< precision >	stored_caliph_B
precision	stored_caliph_D
precision	stored_caliph_M
emitter *	emtr_a
emitter *	emtr_b
Static Protected Attributes
double	Xi = get_Xi()

---

Detailed Description

template<typename precision>
class Arroyo::phase_covariance< precision, circular_aperture >

A class to represent the phase covariance between two emitters. Template specialization for circular apertures

---

Constructor & Destructor Documentation

template<typename precision> Arroyo::phase_covariance< precision, circular_aperture >::~phase_covariance (   )  [inline]

Destructor

---

Member Function Documentation

template<typename precision> double Arroyo::phase_covariance< precision, circular_aperture >::aperture_averaged_variance (  double  wavelength_meters, int  nsteps_in_integration )  const

Function to return the aperture averaged variance

template<typename precision> pixel_array< precision > Arroyo::phase_covariance< precision, circular_aperture >::covariance (  double  pixel_scale_meters, double  wavelength_meters, int  nsteps_in_integration, int  xindex, int  yindex, bool  first_arg = true )  const

Function to return a pixel array containing the covariances between the point with index (xindex,yindex) and every other point in the aperture

template<typename precision> pixel_array< precision > Arroyo::phase_covariance< precision, circular_aperture >::covariance (  double  pixel_scale_meters, double  wavelength_meters, int  nsteps_in_integration, const three_point &  tp, bool  first_arg = true )  const

Function to return a pixel array containing the covariances between the point tp and every other point in the aperture

template<typename precision> double Arroyo::phase_covariance< precision, circular_aperture >::covariance (  double  wavelength_meters, int  nsteps_in_integration, const three_point &  tp1, const three_point &  tp2 )  const

Function to return the covariance between the points tp1 and tp2

template<typename precision> circular_aperture Arroyo::phase_covariance< precision, circular_aperture >::get_aperture (   )  const [inline]

Get a reference to the aperture

template<typename precision> const emitter& Arroyo::phase_covariance< precision, circular_aperture >::get_first_emitter (   )  const [inline]

Get a reference to the first emitter

template<typename precision> const refractive_atmospheric_model& Arroyo::phase_covariance< precision, circular_aperture >::get_model (   )  const [inline]

Get a reference to the refractive atmospheric model

template<typename precision> const emitter& Arroyo::phase_covariance< precision, circular_aperture >::get_second_emitter (   )  const [inline]

Get a reference to the second emitter

template<typename precision> void Arroyo::phase_covariance< precision, circular_aperture >::initialize_integration (  int  nsteps_in_integration  )  const [protected]

template<typename precision> void Arroyo::phase_covariance< precision, circular_aperture >::initialize_pixel_scale (  double  pixel_scale_meters  )  const [protected]

template<typename precision> phase_covariance< precision, circular_aperture > & Arroyo::phase_covariance< precision, circular_aperture >::operator= (  const phase_covariance< precision, circular_aperture > &  pcv  )

Operator =

template<typename precision> Arroyo::phase_covariance< precision, circular_aperture >::phase_covariance (  const iofits &  iof  )  [inline]

Construct from an iofits object

template<typename precision> Arroyo::phase_covariance< precision, circular_aperture >::phase_covariance (  const char *  filename  )  [inline]

Construct from file

template<typename precision> Arroyo::phase_covariance< precision, circular_aperture >::phase_covariance (  const phase_covariance< precision, circular_aperture > &  pcv  )  [inline]

Copy constructor

template<typename precision> Arroyo::phase_covariance< precision, circular_aperture >::phase_covariance (  const emitter &  emtr1, const emitter &  emtr2, const refractive_atmospheric_model &  ref_atm_model, const circular_aperture &  circ_ap )

Constructor

template<typename precision> Arroyo::phase_covariance< precision, circular_aperture >::phase_covariance (   )  [inline]

Null constructor

template<typename precision> void Arroyo::phase_covariance< precision, circular_aperture >::print (  std::ostream &  os, const char *  prefix = "" )  const

Function to print the coefficients

template<typename precision> void Arroyo::phase_covariance< precision, circular_aperture >::read (  const Arroyo::iofits &  iof  )

read from an iofits object

template<typename precision> void Arroyo::phase_covariance< precision, circular_aperture >::read (  const char *  filename  )

read from a file

template<typename precision> pixel_array< precision > Arroyo::phase_covariance< precision, circular_aperture >::variance (  double  pixel_scale_meters, double  wavelength_meters, int  nsteps_in_integration )  const

Function to return a pixel array containing the variances

template<typename precision> double Arroyo::phase_covariance< precision, circular_aperture >::variance (  double  wavelength_meters, int  nsteps_in_integration, const three_point &  tp )  const

Function to return the variance at the point tp

template<typename precision> void Arroyo::phase_covariance< precision, circular_aperture >::write (  Arroyo::iofits &  iof  )  const

write to an iofits object

template<typename precision> void Arroyo::phase_covariance< precision, circular_aperture >::write (  const char *  filename  )  const

write to a file

---

Member Data Documentation

template<typename precision> circular_aperture Arroyo::phase_covariance< precision, circular_aperture >::circ_ap [protected]

template<typename precision> emitter* Arroyo::phase_covariance< precision, circular_aperture >::emtr_a [protected]

template<typename precision> emitter* Arroyo::phase_covariance< precision, circular_aperture >::emtr_b [protected]

template<typename precision> int Arroyo::phase_covariance< precision, circular_aperture >::nsteps_in_integration [mutable, protected]

template<typename precision> double Arroyo::phase_covariance< precision, circular_aperture >::pixel_scale_meters [mutable, protected]

template<typename precision> refractive_atmospheric_model Arroyo::phase_covariance< precision, circular_aperture >::ref_atm_model [protected]

template<typename precision> pixel_array<precision> Arroyo::phase_covariance< precision, circular_aperture >::stored_caliph_A [mutable, protected]

template<typename precision> pixel_array<precision> Arroyo::phase_covariance< precision, circular_aperture >::stored_caliph_B [mutable, protected]

template<typename precision> precision Arroyo::phase_covariance< precision, circular_aperture >::stored_caliph_D [mutable, protected]

template<typename precision> precision Arroyo::phase_covariance< precision, circular_aperture >::stored_caliph_M [mutable, protected]

template<typename precision> double Arroyo::phase_covariance< precision, circular_aperture >::Xi = get_Xi() [static, protected]

---

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

• covariance.h

---