mx::AO::sim::turbLayer< _aoSystemT > Struct Template Reference

template<typename _aoSystemT>
struct mx::AO::sim::turbLayer< _aoSystemT >

Simulation of a single turbulent layer.

Todo:

document this

add facility for changing interpolator

Definition at line 55 of file turbLayer.hpp.

#include <ao/sim/turbLayer.hpp>

Public Member Functions
void	genDealloc ()
	Deallocate memory necessary for phase screen generation.
void	shift (realT dt)
	Shift to a timestep.
void	initRandom ()
	Seed the uniform deviation. Call this if you intend to use shiftRandom.
void	shiftRandom (bool nofract=false)
	Shift by a random amount using the uniform distribution.

Public Attributes
mx::math::uniDistT< realT >	uniVar
	Uniform deviate, used in shiftRandom.

Member Function Documentation

genDealloc()

template<typename aoSystemT >

void mx::AO::sim::turbLayer< aoSystemT >::genDealloc

(

)

Deallocate memory necessary for phase screen generation.

Definition at line 276 of file turbLayer.hpp.

initRandom()

template<typename aoSystemT >

void mx::AO::sim::turbLayer< aoSystemT >::initRandom

(

)

Seed the uniform deviation. Call this if you intend to use shiftRandom.

This only needs to be called once.

Definition at line 315 of file turbLayer.hpp.

shift()

template<typename aoSystemT >

void mx::AO::sim::turbLayer< aoSystemT >::shift

(

realT

dt

)

Shift to a timestep.

Parameters

[in]

dt

is the new timestep.

Definition at line 283 of file turbLayer.hpp.

References mx::improc::imageShift(), and mx::improc::imageShiftWP().

shiftRandom()

template<typename aoSystemT >

void mx::AO::sim::turbLayer< aoSystemT >::shiftRandom

(

bool

nofract = false

)

Shift by a random amount using the uniform distribution.

Call initRandom() once before calling this method.

Parameters

[in]

nofract

if true then the fractional part is ignored, and only a whole-pixel shift is executed. Default=false

Definition at line 321 of file turbLayer.hpp.

References mx::improc::imageShift(), and mx::improc::imageShiftWP().

Member Data Documentation

uniVar

template<typename _aoSystemT >

mx::math::uniDistT<realT> mx::AO::sim::turbLayer< _aoSystemT >::uniVar

Uniform deviate, used in shiftRandom.

Definition at line 84 of file turbLayer.hpp.

---

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

• ao/sim/turbLayer.hpp