mx::AO::sim::wavefront< _realT > Struct Template Reference

template<typename _realT>
struct mx::AO::sim::wavefront< _realT >

Structure containing the phase and amplitude of a wavefront.

The phase and amplitude are stored separately in real valued arrays.

Definition at line 23 of file wavefront.hpp.

#include <ao/sim/wavefront.hpp>

Public Types
typedef _realT	realT
	The floating point type used for all calculations.
typedef Eigen::Array< _realT, Eigen::Dynamic, Eigen::Dynamic >	realImageT
	The data type of the real image, used to hold the phase and amplitude.
typedef wfp::imagingArray< std::complex< realT >, wfp::fftwAllocator< std::complex< realT > >, 0 >	complexAmplitudeT
	The wavefront data type.

Public Member Functions
void	setZero ()
	Zero the wavefront.

Public Attributes
realImageT	amplitude
	The wavefront amplitude.
realImageT	phase
	The wavefront phase.
realT	lambda
	The wavelength at which the wavefront is specified.
realT	iterNo
	The iteration number of this wavefront.

Member Typedef Documentation

complexAmplitudeT

template<typename _realT >

typedef wfp::imagingArray<std::complex<realT>, wfp::fftwAllocator<std::complex<realT> >, 0> mx::AO::sim::wavefront< _realT >::complexAmplitudeT

The wavefront data type.

Definition at line 32 of file wavefront.hpp.

realImageT

template<typename _realT >

typedef Eigen::Array<_realT, Eigen::Dynamic, Eigen::Dynamic> mx::AO::sim::wavefront< _realT >::realImageT

The data type of the real image, used to hold the phase and amplitude.

Definition at line 29 of file wavefront.hpp.

realT

template<typename _realT >

typedef _realT mx::AO::sim::wavefront< _realT >::realT

The floating point type used for all calculations.

Definition at line 26 of file wavefront.hpp.

Member Function Documentation

setZero()

template<typename _realT >

void mx::AO::sim::wavefront< _realT >::setZero ( )

inline

Zero the wavefront.

Definition at line 47 of file wavefront.hpp.

References mx::AO::sim::wavefront< _realT >::amplitude, and mx::AO::sim::wavefront< _realT >::phase.

Member Data Documentation

amplitude

template<typename _realT >

realImageT mx::AO::sim::wavefront< _realT >::amplitude

The wavefront amplitude.

Definition at line 35 of file wavefront.hpp.

Referenced by mx::AO::sim::wavefront< _realT >::setZero().

iterNo

template<typename _realT >

realT mx::AO::sim::wavefront< _realT >::iterNo

The iteration number of this wavefront.

Definition at line 44 of file wavefront.hpp.

lambda

template<typename _realT >

realT mx::AO::sim::wavefront< _realT >::lambda

The wavelength at which the wavefront is specified.

Definition at line 41 of file wavefront.hpp.

phase

template<typename _realT >

realImageT mx::AO::sim::wavefront< _realT >::phase

The wavefront phase.

Definition at line 38 of file wavefront.hpp.

Referenced by mx::AO::sim::wavefront< _realT >::setZero().

---

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

• ao/sim/wavefront.hpp