Arroyo::diffractive_wavefront_header< T > Class Template Reference

#include <wavefront_header.h>

Inheritance diagram for Arroyo::diffractive_wavefront_header< T >:

List of all members.

Public Member Functions
	diffractive_wavefront_header ()
	diffractive_wavefront_header (const iofits &iof)
	diffractive_wavefront_header (const diffractive_wavefront_header< T > &dwfh)
	diffractive_wavefront_header (const vector< long > &in_axes, const three_frame &tf, double in_wavelength, double in_pixel_scale, double in_curvature=0)
	~diffractive_wavefront_header ()
diffractive_wavefront_header &	operator= (const diffractive_wavefront_header< T > &dwfh)
void	read (const iofits &iof)
void	write (iofits &iof) const
void	print (ostream &os, const char *prefix="") const
double	get_wavelength () const
double	set_wavelength (double wvlngth)
rectangular_region	get_covering_region (const three_frame &tf, bool foreshortening) const
long	total_space () const
vector< long >	get_axes () const
void	set_axes (const vector< long > &in_axes)
double	get_pixel_scale () const
void	set_pixel_scale (double pixscale)
double	get_curvature () const
void	set_curvature (double in_curvature)
Protected Attributes
double	wavelength
	The wavelength of the radiation in meters.
double	pixel_scale
	The pixel scale of the array.
double	curvature
double	radiometric_conversion
vector< long >	axes
	The dimensions of the array.
Friends
bool	operator== (const diffractive_wavefront_header< T > &dwfh1, const diffractive_wavefront_header< T > &dwfh2)

---

Detailed Description

template<class T>
class Arroyo::diffractive_wavefront_header< T >

class to hold the diffractive_wavefront parameters.

---

Constructor & Destructor Documentation

template<class T> Arroyo::diffractive_wavefront_header< T >::diffractive_wavefront_header (   )

Null constructor

template<class T> Arroyo::diffractive_wavefront_header< T >::diffractive_wavefront_header (  const iofits &  iof  )

Construct from an iofits object

template<class T> Arroyo::diffractive_wavefront_header< T >::diffractive_wavefront_header (  const diffractive_wavefront_header< T > &  dwfh  )

Copy constructor

template<class T> Arroyo::diffractive_wavefront_header< T >::diffractive_wavefront_header (  const vector< long > &  in_axes, const three_frame &  tf, double  in_wavelength, double  in_pixel_scale, double  in_curvature = 0 )

Construct from the bits wavelength in meters pixel_scale in meters

template<class T> Arroyo::diffractive_wavefront_header< T >::~diffractive_wavefront_header (   )  [inline]

Destructor

---

Member Function Documentation

template<class T> vector<long> Arroyo::diffractive_wavefront_header< T >::get_axes (  void   )  const [inline]

Returns the axes

template<class T> rectangular_region Arroyo::diffractive_wavefront_header< T >::get_covering_region (  const three_frame &  tf, bool  foreshortening )  const

template<class T> double Arroyo::diffractive_wavefront_header< T >::get_curvature (   )  const [inline]

Returns the curvature of the wavefront, in 1/meters

template<class T> double Arroyo::diffractive_wavefront_header< T >::get_pixel_scale (   )  const [inline]

Returns the pixel scale of the wavefront

template<class T> double Arroyo::diffractive_wavefront_header< T >::get_wavelength (   )  const [inline, virtual]

Function to retrieve the wavelength of the radiation Implements Arroyo::wavefront_header.

template<class T> diffractive_wavefront_header< T > & Arroyo::diffractive_wavefront_header< T >::operator= (  const diffractive_wavefront_header< T > &  dwfh  )

Operator =

template<class T> void Arroyo::diffractive_wavefront_header< T >::print (  ostream &  os, const char *  prefix = "" )  const [virtual]

Print the diffractive wavefront header Reimplemented from Arroyo::wavefront_header. Reimplemented in Arroyo::diffractive_wavefront< T >.

template<class T> void Arroyo::diffractive_wavefront_header< T >::read (  const iofits &  iof  )

Read diffractive_wavefront_header from iofits Reimplemented from Arroyo::three_frame. Reimplemented in Arroyo::diffractive_wavefront< T >.

template<class T> void Arroyo::diffractive_wavefront_header< T >::set_axes (  const vector< long > &  in_axes  )

Sets the axes

template<class T> void Arroyo::diffractive_wavefront_header< T >::set_curvature (  double  in_curvature  )  [inline]

Sets the curvature of the wavefront Units of in_curvature are 1/meters

template<class T> void Arroyo::diffractive_wavefront_header< T >::set_pixel_scale (  double  pixscale  )  [inline]

Returns the pixel scale of the wavefront

template<class T> double Arroyo::diffractive_wavefront_header< T >::set_wavelength (  double  wvlngth  )  [inline, virtual]

Function to set the wavelength of the radiation. The function argument wvlngth is in meters Implements Arroyo::wavefront_header.

template<class T> long Arroyo::diffractive_wavefront_header< T >::total_space (   )  const

Returns the number of elements in the data array

template<class T> void Arroyo::diffractive_wavefront_header< T >::write (  iofits &  iof  )  const

Write diffractive_wavefront_header to iofits Reimplemented from Arroyo::three_frame. Reimplemented in Arroyo::diffractive_wavefront< T >.

---

Friends And Related Function Documentation

template<class T> bool operator== (  const diffractive_wavefront_header< T > &  dwfh1, const diffractive_wavefront_header< T > &  dwfh2 )  [friend]

Friend operator== for diffractive wavefront headers

---

Member Data Documentation

template<class T> vector<long> Arroyo::diffractive_wavefront_header< T >::axes [protected]

The dimensions of the array.

template<class T> double Arroyo::diffractive_wavefront_header< T >::curvature [protected]

parameter to specify vergence of the beam. Positive curvature implies diverging beam. Zero curvature implies a plane wave.

template<class T> double Arroyo::diffractive_wavefront_header< T >::pixel_scale [protected]

The pixel scale of the array.

template<class T> double Arroyo::diffractive_wavefront_header< T >::radiometric_conversion [protected]

To be specified in the future. A parameter to specify the conversion to units of power, or some such unit

template<class T> double Arroyo::diffractive_wavefront_header< T >::wavelength [protected]

The wavelength of the radiation in meters.

---

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

• wavefront_header.h

---