template<typename _aoSystemT, class _verboseT = mx::verbose::d>
struct mx::AO::sim::turbAtmosphere< _aoSystemT, _verboseT >

A turbulent atmosphere simulator.

Generate multi-layer phase screens using PSD filtering with the FFT. Manages the shifting and combination of the phase screens (without propagation).

The turbSubHarmonic class provides low-frequency sub-harmonics if desired

The turbLayer class manages the actual interpolation.

Todo:

add facility for switching interpolators

need to include wrap detection when using subharmonics (e.g. frames needs to be right)

Definition at line 81 of file turbAtmosphere.hpp.

#include <ao/sim/turbAtmosphere.hpp>

Inheritance diagram for mx::AO::sim::turbAtmosphere< _aoSystemT, _verboseT >:

Public Member Functions
int	wfPS (realT ps)
	dummy function for simulatedAOSystem. Does nothing.

Construction and Configuration
	turbAtmosphere ()
	Default c'tor.

void	setup (uint32_t wfSz, uint32_t buffSz, aoSystemT *aosys, uint32_t shLevel)
	Setup the overall atmosphere.

void	wfSz (uint32_t ws)
	Set the wavefront size.

uint32_t	wfSz ()
	Get the wavefront size.

void	buffSz (uint32_t bs)
	Set the interpolation buffer size.

uint32_t	buffSz ()
	Get the interpolation buffer size.

void	aosys (aoSystemT *aos)
	Set the pointer to an AO system object.

aoSystemT *	aosys ()
	Get the pointer to an AO system object.

void	shLevel (uint32_t shl)
	Set the subharmonic level.

uint32_t	shLevel ()
	Get the subharmonic level.

void	outerSubHarmonics (bool osh)
	Set whether outer subharmonics are included.

bool	outerSubHarmonics ()
	Get whether outer subharmonics are included.

void	shPreCalc (bool shp)
	Set whether subharmonic modes are pre-calculated.

bool	shPreCalc ()
	Get whether subharmonic modes are pre-calculated.

void	retain (bool rtn)
	Set whether memory for screen generation is retained.

bool	retain ()
	Get whether memory for screen generation is retained.

void	forceGen (bool fg)
	Set whether new screen generation is forced.

bool	forceGen ()
	Get whether new screen generation is forced.

void	dataDir (const std::string &dd)
	Set the data directory for saving phase screens.

std::string	dataDir ()
	Get the data directory for saving phase screens.

void	setLayers (const std::vector< size_t > &scrnSz)
	Setup the layers and prepare them for phase screen generation.

void	setLayers (const size_t scrnSz)
	Setup the layers and prepare them for phase screen generation.

uint32_t	nLayers ()
	Get the number of layers.

turbLayer< aoSystemT > &	layer (uint32_t n)
	Get a layer.

math::normDistT< realT > &	normVar ()
	Get the random number generator.

Screen Generation
void	genLayers ()
	Generate all phase screens.

Public Member Functions inherited from mx::base::changeable< _derivedT >
void	changed ()
	Increment the counter.

changeT	change ()
	Get the value of the counter.

Protected Attributes
Configuration Data
uint32_t	m_wfSz { 0 }
	Size of the wavefront in pixels.

uint32_t	m_buffSz { 0 }
	Buffer to apply around wavefront for interpolation.

aoSystemT *	m_aosys { nullptr }
	The AO system object containing all system parameters. See aoSystem.

uint32_t	m_shLevel { 0 }

bool	m_outerSubHarmonics { true }

bool	m_shPreCalc { true }

bool	m_retain { false }

bool	m_forceGen { true }

std::string	m_dataDir

imageT *	m_pupil { 0 }
	A pointer to the pupil mask.

realT	m_timeStep { 0 }
	Length of each iteration, in seconds.

Internal State
std::vector< turbLayer< aoSystemT > >	m_layers
	Vector of turbulent layers.

std::vector< turbSubHarmonic< turbAtmosphere > >	m_subHarms
	Sub-harmonic layers.

size_t	m_frames { 0 }
	Length of the turbulence sequence.

int	m_nWf { 0 }
	Number of iterations which have occurred.

math::normDistT< realT >	m_normVar
	Normal random deviate generator. This seeded in the constructor.

Additional Inherited Members
Public Types inherited from mx::base::changeable< _derivedT >
typedef uint64_t	changeT
	The integer type of the counter.

Constructor & Destructor Documentation

◆ turbAtmosphere()

template<typename aoSystemT , class verboseT >

mx::AO::sim::turbAtmosphere< aoSystemT, verboseT >::turbAtmosphere ( )

Default c'tor.

Definition at line 345 of file turbAtmosphere.hpp.

Member Function Documentation

◆ aosys() [1/2]

template<typename aoSystemT , class verboseT >

aoSystemT * mx::AO::sim::turbAtmosphere< aoSystemT, verboseT >::aosys ( )

Get the pointer to an AO system object.

Returns: the current value of m_aosys

Definition at line 402 of file turbAtmosphere.hpp.

◆ aosys() [2/2]

template<typename aoSystemT , class verboseT >

void mx::AO::sim::turbAtmosphere< aoSystemT, verboseT >::aosys ( aoSystemT * aos )

Set the pointer to an AO system object.

see m_aosys

Parameters

[in] aos the new pointer to an AO system object

Definition at line 392 of file turbAtmosphere.hpp.

◆ buffSz() [1/2]

template<typename aoSystemT , class verboseT >

uint32_t mx::AO::sim::turbAtmosphere< aoSystemT, verboseT >::buffSz ( )

Get the interpolation buffer size.

Returns: the current value of m_buffSz

Definition at line 386 of file turbAtmosphere.hpp.

◆ buffSz() [2/2]

template<typename aoSystemT , class verboseT >

void mx::AO::sim::turbAtmosphere< aoSystemT, verboseT >::buffSz ( uint32_t bs )

Set the interpolation buffer size.

see m_buffSz

Parameters

[in] bs the new buffer size

Definition at line 376 of file turbAtmosphere.hpp.

◆ dataDir() [1/2]

template<typename aoSystemT , class verboseT >

std::string mx::AO::sim::turbAtmosphere< aoSystemT, verboseT >::dataDir ( )

Get the data directory for saving phase screens.

Returns: the current value of m_dataDir

Definition at line 500 of file turbAtmosphere.hpp.

◆ dataDir() [2/2]

template<typename aoSystemT , class verboseT >

void mx::AO::sim::turbAtmosphere< aoSystemT, verboseT >::dataDir ( const std::string & dd )

Set the data directory for saving phase screens.

see m_dataDir

Parameters

[in] dd the new data directory for phase screen saving

Definition at line 489 of file turbAtmosphere.hpp.

◆ forceGen() [1/2]

template<typename aoSystemT , class verboseT >

bool mx::AO::sim::turbAtmosphere< aoSystemT, verboseT >::forceGen ( )

Get whether new screen generation is forced.

Returns: the current value of m_forceGen

Definition at line 483 of file turbAtmosphere.hpp.

◆ forceGen() [2/2]

template<typename aoSystemT , class verboseT >

void mx::AO::sim::turbAtmosphere< aoSystemT, verboseT >::forceGen ( bool fg )

Set whether new screen generation is forced.

see m_forceGen

Parameters

[in] fg the new value of the flag controlling whether screen generation is forced

Definition at line 472 of file turbAtmosphere.hpp.

◆ genLayers()

template<typename aoSystemT , class verboseT >

void mx::AO::sim::turbAtmosphere< aoSystemT, verboseT >::genLayers ( )

Generate all phase screens.

Loads them from disk if possible and m_forceGen == false.

Deallocates working memory when done, unless m_retain == true.

Definition at line 634 of file turbAtmosphere.hpp.

References mx::fits::fitsFile< dataT, verboseT >::read(), mx::sizeerr, and mx::fits::fitsFile< dataT, verboseT >::write().

◆ layer()

template<typename aoSystemT , class verboseT >

turbLayer< aoSystemT > & mx::AO::sim::turbAtmosphere< aoSystemT, verboseT >::layer ( uint32_t n )

Get a layer.

Returns: a reference to on entry in m_layers

Definition at line 576 of file turbAtmosphere.hpp.

References mx::invalidarg.

◆ nLayers()

template<typename aoSystemT , class verboseT >

uint32_t mx::AO::sim::turbAtmosphere< aoSystemT, verboseT >::nLayers ( )

Get the number of layers.

Returns: the size of the layers vector m_layers

Definition at line 570 of file turbAtmosphere.hpp.

◆ normVar()

template<typename aoSystemT , class verboseT >

math::normDistT< typename aoSystemT::realT > & mx::AO::sim::turbAtmosphere< aoSystemT, verboseT >::normVar ( )

Get the random number generator.

Returns: a reference to m_normVar

Definition at line 587 of file turbAtmosphere.hpp.

◆ outerSubHarmonics() [1/2]

template<typename aoSystemT , class verboseT >

bool mx::AO::sim::turbAtmosphere< aoSystemT, verboseT >::outerSubHarmonics ( )

Get whether outer subharmonics are included.

Returns: the current value of m_outerSubHarmonics

Definition at line 434 of file turbAtmosphere.hpp.

◆ outerSubHarmonics() [2/2]

template<typename aoSystemT , class verboseT >

void mx::AO::sim::turbAtmosphere< aoSystemT, verboseT >::outerSubHarmonics ( bool osh )

Set whether outer subharmonics are included.

see m_outerSubHarmonics

Parameters

[in] osh the new value of flag controlling outer subharmonics

Definition at line 424 of file turbAtmosphere.hpp.

◆ retain() [1/2]

template<typename aoSystemT , class verboseT >

bool mx::AO::sim::turbAtmosphere< aoSystemT, verboseT >::retain ( )

Get whether memory for screen generation is retained.

Returns: the current value of m_retain

Definition at line 466 of file turbAtmosphere.hpp.

◆ retain() [2/2]

template<typename aoSystemT , class verboseT >

void mx::AO::sim::turbAtmosphere< aoSystemT, verboseT >::retain ( bool rtn )

Set whether memory for screen generation is retained.

see m_retain

Parameters

[in] rtn the new value of the flag controlling whether memory is retained

Definition at line 456 of file turbAtmosphere.hpp.

◆ setLayers() [1/2]

template<typename aoSystemT , class verboseT >

void mx::AO::sim::turbAtmosphere< aoSystemT, verboseT >::setLayers ( const size_t scrnSz )

Setup the layers and prepare them for phase screen generation.

This sets all layer phase screens to be the same size.

Parameters

[in] scrnSz the screen sizes for all layers.

Definition at line 555 of file turbAtmosphere.hpp.

References mx::paramnotset.

◆ setLayers() [2/2]

template<typename aoSystemT , class verboseT >

void mx::AO::sim::turbAtmosphere< aoSystemT, verboseT >::setLayers ( const std::vector< size_t > & scrnSz )

Setup the layers and prepare them for phase screen generation.

The number of entries in scrnSz must mach the number of layers in the atmosphere of m_aosys.

Parameters

[in] scrnSz the screen sizes for each layer.

Definition at line 506 of file turbAtmosphere.hpp.

References mx::invalidarg, and mx::paramnotset.

◆ setup()

template<typename aoSystemT , class verboseT >

void mx::AO::sim::turbAtmosphere< aoSystemT, verboseT >::setup	(	uint32_t	wfSz,
		uint32_t	buffSz,
		aoSystemT *	aosys,
		uint32_t	shLevel
	)

Setup the overall atmosphere.

Parameters

[in]	wfSz	The size of the wavefront in pixels.
[in]	buffSz	The size of the interpolation buffer to use.
[in]	aosys	Pointer to an AO System. See m_aosys.
[in]	shLevel	number of subharmonic levels to use. 0 turns off subharmonics. See m_shLevel.

Definition at line 351 of file turbAtmosphere.hpp.

◆ shLevel() [1/2]

template<typename aoSystemT , class verboseT >

uint32_t mx::AO::sim::turbAtmosphere< aoSystemT, verboseT >::shLevel ( )

Get the subharmonic level.

Returns: the current value of m_shLevel

Definition at line 418 of file turbAtmosphere.hpp.

◆ shLevel() [2/2]

template<typename aoSystemT , class verboseT >

void mx::AO::sim::turbAtmosphere< aoSystemT, verboseT >::shLevel ( uint32_t shl )

Set the subharmonic level.

see m_shLevel

Parameters

[in] shl the new subharmonic level

Definition at line 408 of file turbAtmosphere.hpp.

◆ shPreCalc() [1/2]

template<typename aoSystemT , class verboseT >

bool mx::AO::sim::turbAtmosphere< aoSystemT, verboseT >::shPreCalc ( )

Get whether subharmonic modes are pre-calculated.

Returns: the current value of m_shPreCalc

Definition at line 450 of file turbAtmosphere.hpp.

◆ shPreCalc() [2/2]

template<typename aoSystemT , class verboseT >

void mx::AO::sim::turbAtmosphere< aoSystemT, verboseT >::shPreCalc ( bool shp )

Set whether subharmonic modes are pre-calculated.

see m_shPreCalc

Parameters

[in] shp the new value of flag controlling subharmonic mode precalculation

Definition at line 440 of file turbAtmosphere.hpp.

◆ wfPS()

template<typename aoSystemT , class verboseT >

int mx::AO::sim::turbAtmosphere< aoSystemT, verboseT >::wfPS ( realT ps )

dummy function for simulatedAOSystem. Does nothing.

Definition at line 784 of file turbAtmosphere.hpp.

◆ wfSz() [1/2]

template<typename aoSystemT , class verboseT >

uint32_t mx::AO::sim::turbAtmosphere< aoSystemT, verboseT >::wfSz ( )

Get the wavefront size.

Returns: the current value of m_wfSz

Definition at line 370 of file turbAtmosphere.hpp.

◆ wfSz() [2/2]

template<typename aoSystemT , class verboseT >

void mx::AO::sim::turbAtmosphere< aoSystemT, verboseT >::wfSz ( uint32_t ws )

Set the wavefront size.

see m_wfSz

Parameters

[in] ws the new wavefront size

Definition at line 360 of file turbAtmosphere.hpp.

Member Data Documentation

◆ m_aosys

template<typename _aoSystemT , class _verboseT = mx::verbose::d>

aoSystemT* mx::AO::sim::turbAtmosphere< _aoSystemT, _verboseT >::m_aosys { nullptr }

protected

The AO system object containing all system parameters. See aoSystem.

Definition at line 99 of file turbAtmosphere.hpp.

◆ m_buffSz

template<typename _aoSystemT , class _verboseT = mx::verbose::d>

uint32_t mx::AO::sim::turbAtmosphere< _aoSystemT, _verboseT >::m_buffSz { 0 }

protected

Buffer to apply around wavefront for interpolation.

Definition at line 97 of file turbAtmosphere.hpp.

◆ m_dataDir

template<typename _aoSystemT , class _verboseT = mx::verbose::d>

std::string mx::AO::sim::turbAtmosphere< _aoSystemT, _verboseT >::m_dataDir

protected

Specifies a path where phase screens are stored. Leaving this unset or "" is equivalent to m_forceGen` == true`.

Definition at line 126 of file turbAtmosphere.hpp.

◆ m_forceGen

template<typename _aoSystemT , class _verboseT = mx::verbose::d>

bool mx::AO::sim::turbAtmosphere< _aoSystemT, _verboseT >::m_forceGen { true }

protected

Force generation of new screens if true. Note that this class does not presently do any checks of saved screens to verify they match the current configuration. Set to true with caution.

Todo:: need check for changes in parameters to decide if saved frames are valid per layer

Definition at line 119 of file turbAtmosphere.hpp.

◆ m_frames

template<typename _aoSystemT , class _verboseT = mx::verbose::d>

size_t mx::AO::sim::turbAtmosphere< _aoSystemT, _verboseT >::m_frames { 0 }

protected

Length of the turbulence sequence.

Definition at line 143 of file turbAtmosphere.hpp.

◆ m_layers

template<typename _aoSystemT , class _verboseT = mx::verbose::d>

std::vector<turbLayer<aoSystemT> > mx::AO::sim::turbAtmosphere< _aoSystemT, _verboseT >::m_layers

protected

Vector of turbulent layers.

Definition at line 139 of file turbAtmosphere.hpp.

◆ m_normVar

template<typename _aoSystemT , class _verboseT = mx::verbose::d>

math::normDistT<realT> mx::AO::sim::turbAtmosphere< _aoSystemT, _verboseT >::m_normVar

protected

Normal random deviate generator. This seeded in the constructor.

Definition at line 147 of file turbAtmosphere.hpp.

◆ m_nWf

template<typename _aoSystemT , class _verboseT = mx::verbose::d>

int mx::AO::sim::turbAtmosphere< _aoSystemT, _verboseT >::m_nWf { 0 }

protected

Number of iterations which have occurred.

Definition at line 145 of file turbAtmosphere.hpp.

◆ m_outerSubHarmonics

template<typename _aoSystemT , class _verboseT = mx::verbose::d>

bool mx::AO::sim::turbAtmosphere< _aoSystemT, _verboseT >::m_outerSubHarmonics { true }

protected

Whether or not the outer subharmonics are included. See m_turbSubHarmonic.

Definition at line 105 of file turbAtmosphere.hpp.

◆ m_pupil

template<typename _aoSystemT , class _verboseT = mx::verbose::d>

imageT* mx::AO::sim::turbAtmosphere< _aoSystemT, _verboseT >::m_pupil { 0 }

protected

A pointer to the pupil mask.

Definition at line 130 of file turbAtmosphere.hpp.

◆ m_retain

template<typename _aoSystemT , class _verboseT = mx::verbose::d>

bool mx::AO::sim::turbAtmosphere< _aoSystemT, _verboseT >::m_retain { false }

protected

Whether or not to retain working memory after screen generation. One would set to true if many screens will be calculated in monte carlo fashion. For a standard case of one set of screens being shifted by wind velocity, this should be false to minimize memory use.

Definition at line 113 of file turbAtmosphere.hpp.

◆ m_shLevel

template<typename _aoSystemT , class _verboseT = mx::verbose::d>

uint32_t mx::AO::sim::turbAtmosphere< _aoSystemT, _verboseT >::m_shLevel { 0 }

protected

Number of subharmonic levels. 0 means no subharmonics. Generally only 1 level is needed to obtain good Tip/Tilt results. See turbSubHarmonic.

Definition at line 101 of file turbAtmosphere.hpp.

◆ m_shPreCalc

template<typename _aoSystemT , class _verboseT = mx::verbose::d>

bool mx::AO::sim::turbAtmosphere< _aoSystemT, _verboseT >::m_shPreCalc { true }

protected

Whether or not to pre-calculate the subharmonic modes. This is a trade of speed vs. memory use. See turbSubHarmonic.

Definition at line 109 of file turbAtmosphere.hpp.

◆ m_subHarms

template<typename _aoSystemT , class _verboseT = mx::verbose::d>

std::vector<turbSubHarmonic<turbAtmosphere> > mx::AO::sim::turbAtmosphere< _aoSystemT, _verboseT >::m_subHarms

protected

Sub-harmonic layers.

Definition at line 141 of file turbAtmosphere.hpp.

◆ m_timeStep

template<typename _aoSystemT , class _verboseT = mx::verbose::d>

realT mx::AO::sim::turbAtmosphere< _aoSystemT, _verboseT >::m_timeStep { 0 }

protected

Length of each iteration, in seconds.

Definition at line 132 of file turbAtmosphere.hpp.

◆ m_wfSz

template<typename _aoSystemT , class _verboseT = mx::verbose::d>

uint32_t mx::AO::sim::turbAtmosphere< _aoSystemT, _verboseT >::m_wfSz { 0 }

protected

Size of the wavefront in pixels.

Definition at line 95 of file turbAtmosphere.hpp.

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

ao/sim/turbAtmosphere.hpp

Public Member Functions

Protected Attributes

Additional Inherited Members

Constructor & Destructor Documentation

◆ turbAtmosphere()

Member Function Documentation

◆ aosys() [1/2]

◆ aosys() [2/2]

◆ buffSz() [1/2]

◆ buffSz() [2/2]

◆ dataDir() [1/2]

◆ dataDir() [2/2]

◆ forceGen() [1/2]

◆ forceGen() [2/2]

◆ genLayers()

◆ layer()

◆ nLayers()

◆ normVar()

◆ outerSubHarmonics() [1/2]

◆ outerSubHarmonics() [2/2]

◆ retain() [1/2]

◆ retain() [2/2]

◆ setLayers() [1/2]

◆ setLayers() [2/2]

◆ setup()

◆ shLevel() [1/2]

◆ shLevel() [2/2]

◆ shPreCalc() [1/2]

◆ shPreCalc() [2/2]

◆ wfPS()

◆ wfSz() [1/2]

◆ wfSz() [2/2]

Member Data Documentation

◆ m_aosys

◆ m_buffSz

◆ m_dataDir

◆ m_forceGen

◆ m_frames

◆ m_layers

◆ m_normVar

◆ m_nWf

◆ m_outerSubHarmonics

◆ m_pupil

◆ m_retain

◆ m_shLevel

◆ m_shPreCalc

◆ m_subHarms

◆ m_timeStep

◆ m_wfSz