mx::AO::analysis::shwfs< realT, iosT > Struct Template Reference

template<typename realT, typename iosT = std::ostream>
struct mx::AO::analysis::shwfs< realT, iosT >

The shack hartmann wavefront sensor sensitivity function.

Provides the \( \beta_p \) parameter of Guyon, 2005 [9] for the shack hartmann WFS.

Template Parameters

realT	is the floating point type used for calculations
iosT	is an output stream type with operator << defined (default is std::ostream)

Definition at line 230 of file aoWFS.hpp.

#include <ao/analysis/aoWFS.hpp>

Inheritance diagram for mx::AO::analysis::shwfs< realT, iosT >:

Public Member Functions
virtual realT	beta_p (int m, int n, realT D, realT d, realT r0)
	Get the photon noise sensitivity at a spatial frequency. More...
virtual realT	beta_r (int m, int n, realT D, realT d, realT r0)
	Get the read noise sensitivity at a spatial frequency. More...
Public Member Functions inherited from mx::AO::analysis::wfs< realT, std::ostream >
	wfs ()
	Constructor. More...
virtual	~wfs ()
	Destructor. More...
virtual std::ostream &	dumpWFS (std::ostream &ios)
	Dump the details of the WFS to an io stream. More...

Member Function Documentation

beta_p()

template<typename realT , typename iosT = std::ostream>

virtual realT mx::AO::analysis::shwfs< realT, iosT >::beta_p ( int  m, int  n, realT  D, realT  d, realT  r0  )

inlinevirtual

Get the photon noise sensitivity at a spatial frequency.

The photon noise sensitivity of the shack hartmann WFS

Returns

the sensitivity to photon noise parameter

Parameters

[in]	m	the spatial frequency index for u
[in]	n	the spatial frequency index for v
[in]	D	the telescope diameter
[in]	d	the sub-ap spacing
[in]	r0	Fried's parameter

Reimplemented from mx::AO::analysis::wfs< realT, std::ostream >.

Definition at line 242 of file aoWFS.hpp.

References mx::astro::constants::k().

Referenced by mx::AO::analysis::shwfs< realT, iosT >::beta_r().

beta_r()

template<typename realT , typename iosT = std::ostream>

virtual realT mx::AO::analysis::shwfs< realT, iosT >::beta_r ( int  m, int  n, realT  D, realT  d, realT  r0  )

inlinevirtual

Get the read noise sensitivity at a spatial frequency.

Here we assume beta_r = beta_p

Returns

the sensitivity to read noise parameter

Parameters

[in]	m	the spatial frequency index for u
[in]	n	the spatial frequency index for v
[in]	D	the telescope diameter
[in]	d	the sub-ap spacing
[in]	r0	Fried's parameter

Reimplemented from mx::AO::analysis::wfs< realT, std::ostream >.

Definition at line 260 of file aoWFS.hpp.

References mx::AO::analysis::shwfs< realT, iosT >::beta_p().

---

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

• ao/analysis/aoWFS.hpp