mx::AO::analysis::fourierTemporalPSDReport< realT > Struct Template Reference

template<typename realT>
struct mx::AO::analysis::fourierTemporalPSDReport< realT >

Aggregated GSL quadrature diagnostics for a Fourier temporal PSD calculation.

Definition at line 104 of file fourierTemporalPSD.hpp.

#include <ao/analysis/fourierTemporalPSD.hpp>

Classes
struct	statusSummary
	Summary of one GSL status code. More...

Public Member Functions
void	clear ()
	Reset all accumulated diagnostics.
void	record (int status, size_t layer, realT frequency, realT result, realT absoluteError, realT absoluteTolerance, realT relativeTolerance)
	Record one quadrature result.
void	merge (const fourierTemporalPSDReport &other)
	Merge another report into this report.
size_t	failureCount () const
	Return the total number of non-successful integrations.
void	write (std::ostream &output) const
	Write a human-readable summary of the accumulated quadrature diagnostics.

Public Attributes
size_t	integrationsAttempted { 0 }
	Total number of quadrature calls.
size_t	integrationsConverged { 0 }
	Number of quadrature calls returning GSL_SUCCESS.
std::map< int, statusSummary >	gslStatus
	Summaries keyed by the raw GSL status code.

Member Function Documentation

clear()

template<typename realT>

void mx::AO::analysis::fourierTemporalPSDReport< realT >::clear

(

)

Reset all accumulated diagnostics.

Definition at line 244 of file fourierTemporalPSD.hpp.

References gslStatus, integrationsAttempted, and integrationsConverged.

Referenced by mx::AO::analysis::fourierTemporalPSD< _realT, aosysT >::multiLayerPSD(), and mx::AO::analysis::fourierTemporalPSD< _realT, aosysT >::singleLayerPSD().

failureCount()

template<typename realT>

size_t mx::AO::analysis::fourierTemporalPSDReport< realT >::failureCount ( ) const

nodiscard

Return the total number of non-successful integrations.

Definition at line 308 of file fourierTemporalPSD.hpp.

References integrationsAttempted, and integrationsConverged.

Referenced by TEST_CASE().

merge()

template<typename realT>

void mx::AO::analysis::fourierTemporalPSDReport< realT >::merge

(

const fourierTemporalPSDReport< realT > &

other

)

Merge another report into this report.

Parameters

[in]

other

report to merge

Definition at line 284 of file fourierTemporalPSD.hpp.

References mx::AO::analysis::fourierTemporalPSDReport< realT >::statusSummary::count, mx::AO::analysis::fourierTemporalPSDReport< realT >::statusSummary::countByLayer, gslStatus, integrationsAttempted, integrationsConverged, mx::AO::analysis::fourierTemporalPSDReport< realT >::statusSummary::maximumAbsoluteError, mx::AO::analysis::fourierTemporalPSDReport< realT >::statusSummary::maximumToleranceRatio, mx::AO::analysis::fourierTemporalPSDReport< realT >::statusSummary::worstFrequency, and mx::AO::analysis::fourierTemporalPSDReport< realT >::statusSummary::worstLayer.

Referenced by TEST_CASE().

record()

template<typename realT>

void mx::AO::analysis::fourierTemporalPSDReport< realT >::record	(	int	status,
		size_t	layer,
		realT	frequency,
		realT	result,
		realT	absoluteError,
		realT	absoluteTolerance,
		realT	relativeTolerance )

Record one quadrature result.

Parameters

[in]	status	raw GSL status code
[in]	layer	atmospheric layer index
[in]	frequency	temporal frequency
[in]	result	quadrature result
[in]	absoluteError	GSL absolute-error estimate
[in]	absoluteTolerance	requested absolute tolerance
[in]	relativeTolerance	requested relative tolerance

Definition at line 252 of file fourierTemporalPSD.hpp.

References mx::AO::analysis::fourierTemporalPSDReport< realT >::statusSummary::count, mx::AO::analysis::fourierTemporalPSDReport< realT >::statusSummary::countByLayer, gslStatus, integrationsAttempted, integrationsConverged, mx::AO::analysis::fourierTemporalPSDReport< realT >::statusSummary::maximumAbsoluteError, mx::AO::analysis::fourierTemporalPSDReport< realT >::statusSummary::maximumToleranceRatio, mx::AO::analysis::fourierTemporalPSDReport< realT >::statusSummary::worstFrequency, and mx::AO::analysis::fourierTemporalPSDReport< realT >::statusSummary::worstLayer.

Referenced by mx::AO::analysis::fourierTemporalPSD< _realT, aosysT >::singleLayerPSDImpl(), TEST_CASE(), and TEST_CASE().

write()

template<typename realT>

void mx::AO::analysis::fourierTemporalPSDReport< realT >::write

(

std::ostream &

output

)

const

Write a human-readable summary of the accumulated quadrature diagnostics.

Parameters

[out]

output

stream receiving the summary

Definition at line 314 of file fourierTemporalPSD.hpp.

References gslStatus, integrationsAttempted, and integrationsConverged.

Referenced by TEST_CASE().

Member Data Documentation

gslStatus

template<typename realT>

std::map<int, statusSummary> mx::AO::analysis::fourierTemporalPSDReport< realT >::gslStatus

Summaries keyed by the raw GSL status code.

Definition at line 119 of file fourierTemporalPSD.hpp.

Referenced by clear(), merge(), record(), TEST_CASE(), and write().

integrationsAttempted

template<typename realT>

size_t mx::AO::analysis::fourierTemporalPSDReport< realT >::integrationsAttempted { 0 }

Total number of quadrature calls.

Definition at line 117 of file fourierTemporalPSD.hpp.

Referenced by clear(), failureCount(), merge(), record(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), TEST_CASE(), and write().

integrationsConverged

template<typename realT>

size_t mx::AO::analysis::fourierTemporalPSDReport< realT >::integrationsConverged { 0 }

Number of quadrature calls returning GSL_SUCCESS.

Definition at line 118 of file fourierTemporalPSD.hpp.

Referenced by clear(), failureCount(), merge(), record(), TEST_CASE(), and write().

---

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

• ao/analysis/fourierTemporalPSD.hpp