template<typename _realT, typename aosysT>
struct mx::AO::analysis::zernikeTemporalPSD< _realT, aosysT >

Class to manage the calculation of temporal PSDs of the Fourier modes in atmospheric turbulence.

Works with both basic (sines/cosines) and modified Fourier modes.

Template Parameters

realT	is a real floating point type for calculations. Currently must be double due to gsl_integration.
aosysT	is an AO system type, usually of type ao_system.

Todo:

Split off the integration parameters in a separate structure.

once integration parameters are in a separate structure, make this a class with protected members.

GSL error handling

Definition at line 98 of file zernikeTemporalPSD.hpp.

#include <ao/analysis/zernikeTemporalPSD.hpp>

Public Member Functions
void	apertureRatio (realT ar)
	Aperture ratio ^4 used for calculations.

	zernikeTemporalPSD ()
	Default c'tor.

	zernikeTemporalPSD (bool allocate)
	Constructor with workspace allocation.

	~zernikeTemporalPSD ()
	Destructor.

int	singleLayerPSD (std::vector< realT > &PSD, std::vector< realT > &freq, int zern_j, int layer_i, realT fmax=0)
	Calculate the temporal PSD for a Zernike mode for a single layer.

template<bool parallel = true>
int	multiLayerPSD (std::vector< realT > &PSD, std::vector< realT > &freq, int zern_j, realT fmax=0)
	Calculate the temporal PSD for a Fourier mode in a multi-layer model.

GSL Integration Tolerances
For good results it seems that absolute tolerance (absTol) needs to be 1e-10. Lower tolerances cause some frequencies to drop out, etc. Relative tolerance (relTol) seems to be less sensitive, and 1e-4 works on cases tested as of 1 Jan, 2017. See the documentation for the GSL Library integrators at (https://www.gnu.org/software/gsl/manual/htmlm_node/QAGI-adaptive-integration-on-infinite-intervals.html)
void	absTol (realT at)
	Set absolute tolerance.

realT	absTol ()
	Get the current absolute tolerance.

void	relTol (realT rt)
	Set relative tolerance.

realT	relTol ()
	Get the current relative tolerance.

Public Attributes
aosysT *	m_aosys { nullptr }
	Pointer to an AO system structure.

realT	m_f { 0 }
	the current temporal frequency

realT	m_zern_j { 0 }
	the current mode number

int	m_zern_m { 0 }
	The current mode m.

int	m_zern_n { 0 }
	The current mode n.

realT	m_cq { 0 }
	The cosine of the wind direction.

realT	m_sq { 0 }
	The sine of the wind direction.

realT	m_spatialFilter { false }
	Flag indicating if a spatial filter is applied.

int	_layer_i
	The index of the current layer.

gsl_integration_workspace *	_w
	Worskspace for the gsl integrators, allocated to WSZ if constructed as worker (with allocate == true).

realT	_absTol
	The absolute tolerance to use in the GSL integrator.

realT	_relTol
	The relative tolerance to use in the GSL integrator.

Protected Member Functions
void	initialize ()
	Initialize parameters to default values.

Protected Attributes
realT	m_apertureRatio4 { 1 }
	Aperture ratio, < 1, used for segments.

Constructor & Destructor Documentation

◆ zernikeTemporalPSD() [1/2]

template<typename realT , typename aosysT >

mx::AO::analysis::zernikeTemporalPSD< realT, aosysT >::zernikeTemporalPSD ( )

Default c'tor.

Definition at line 262 of file zernikeTemporalPSD.hpp.

◆ zernikeTemporalPSD() [2/2]

template<typename realT , typename aosysT >

mx::AO::analysis::zernikeTemporalPSD< realT, aosysT >::zernikeTemporalPSD ( bool allocate )

explicit

Constructor with workspace allocation.

Parameters

allocate if true, then the workspace for GSL integrators is allocated.

Definition at line 269 of file zernikeTemporalPSD.hpp.

◆ ~zernikeTemporalPSD()

template<typename realT , typename aosysT >

mx::AO::analysis::zernikeTemporalPSD< realT, aosysT >::~zernikeTemporalPSD ( )

Destructor.

Frees GSL workspace if it was allocated.

Definition at line 281 of file zernikeTemporalPSD.hpp.

Member Function Documentation

◆ absTol() [1/2]

template<typename realT , typename aosysT >

realT mx::AO::analysis::zernikeTemporalPSD< realT, aosysT >::absTol ( )

Get the current absolute tolerance.

Returns: _absTol

Definition at line 305 of file zernikeTemporalPSD.hpp.

◆ absTol() [2/2]

template<typename realT , typename aosysT >

void mx::AO::analysis::zernikeTemporalPSD< realT, aosysT >::absTol ( realT at )

Set absolute tolerance.

Parameters

at	is the new absolute tolerance.

Definition at line 299 of file zernikeTemporalPSD.hpp.

◆ apertureRatio()

template<typename _realT , typename aosysT >

void mx::AO::analysis::zernikeTemporalPSD< _realT, aosysT >::apertureRatio ( realT ar )

inline

Aperture ratio ^4 used for calculations.

Definition at line 111 of file zernikeTemporalPSD.hpp.

References mx::AO::analysis::zernikeTemporalPSD< _realT, aosysT >::m_apertureRatio4.

◆ initialize()

template<typename realT , typename aosysT >

void mx::AO::analysis::zernikeTemporalPSD< realT, aosysT >::initialize ( )

protected

Initialize parameters to default values.

Definition at line 290 of file zernikeTemporalPSD.hpp.

◆ multiLayerPSD()

template<typename realT , typename aosysT >

template<bool parallel>

int mx::AO::analysis::zernikeTemporalPSD< realT, aosysT >::multiLayerPSD	(	std::vector< realT > &	PSD,
		std::vector< realT > &	freq,
		int	zern_j,
		realT	fmax = `0`
	)

Calculate the temporal PSD for a Fourier mode in a multi-layer model.

Template Parameters

parallel controls whether layers are calculated in parallel. Default is true. Set to false if this is called inside a parallelized loop, as in makePSDGrid.

Todo:

implement error checking

handle reports of convergence failures form singleLayerPSD when implemented.

Parameters

[out]	PSD	the calculated PSD
[in]	freq	the populated temporal frequency grid defining at which frequencies the PSD is calculated
[in]	fmax	[optional] set the maximum temporal frequency for the calculation. The PSD is filled in with a -17/3 power law past this frequency. If 0, then it is taken to be 150 Hz + 2*fastestPeak(m,n).

Definition at line 463 of file zernikeTemporalPSD.hpp.

◆ relTol() [1/2]

template<typename realT , typename aosysT >

realT mx::AO::analysis::zernikeTemporalPSD< realT, aosysT >::relTol ( )

Get the current relative tolerance.

Returns: _relTol

Definition at line 317 of file zernikeTemporalPSD.hpp.

◆ relTol() [2/2]

template<typename realT , typename aosysT >

void mx::AO::analysis::zernikeTemporalPSD< realT, aosysT >::relTol ( realT rt )

Set relative tolerance.

Parameters

rt	is the new relative tolerance.

Definition at line 311 of file zernikeTemporalPSD.hpp.

◆ singleLayerPSD()

template<typename realT , typename aosysT >

int mx::AO::analysis::zernikeTemporalPSD< realT, aosysT >::singleLayerPSD	(	std::vector< realT > &	PSD,
		std::vector< realT > &	freq,
		int	zern_j,
		int	layer_i,
		realT	fmax = `0`
	)

Calculate the temporal PSD for a Zernike mode for a single layer.

Todo:

implement error checking.

need a way to track convergence failures in integral without throwing an error.

need better handling of averaging for the -17/3 extension.

Parameters

[out]	PSD	the calculated PSD
[in]	freq	the populated temporal frequency grid defining the frequencies at which the PSD is calculated
[in]	zern_j
[in]	layer_i	the index of the layer, for accessing the atmosphere parameters
[in]	fmax	[optional] set the maximum temporal frequency for the calculation. The PSD is filled in with a -17/3 power law past this frequency.