mxlib
c++ tools for analyzing astronomical data and other tasks by Jared R. Males. [git repo]
Loading...
Searching...
No Matches
mx::AO::analysis::clGainOptOptGain_OL< realT > Struct Template Reference

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

Bisection worker struct for finding optimum closed loop gain from open loop PSDs.

Definition at line 1410 of file clGainOpt.hpp.

#include <ao/analysis/clGainOpt.hpp>

Public Member Functions

realT operator() (const realT &g)
 Evaluate closed-loop variance at a candidate gain and update diagnostics.

Public Attributes

clGainOpt< realT > * go { nullptr }
 Gain optimizer used to evaluate variance.
const std::vector< realT > * PSDerr { nullptr }
 Open-loop disturbance PSD.
const std::vector< realT > * PSDnoise { nullptr }
 Measurement-noise PSD.
size_t evaluations { 0 }
 Objective evaluations performed.
realT minimumEvaluatedGain { std::numeric_limits<realT>::max() }
 Smallest gain evaluated.
realT maximumEvaluatedGain { std::numeric_limits<realT>::lowest() }
 Largest gain evaluated.

Member Function Documentation

◆ operator()()

template<typename realT>
realT mx::AO::analysis::clGainOptOptGain_OL< realT >::operator() ( const realT & g)
inline

Evaluate closed-loop variance at a candidate gain and update diagnostics.

Parameters
[in]gcandidate gain

Definition at line 1420 of file clGainOpt.hpp.

References evaluations, go, maximumEvaluatedGain, minimumEvaluatedGain, PSDerr, and PSDnoise.

Member Data Documentation

◆ evaluations

template<typename realT>
size_t mx::AO::analysis::clGainOptOptGain_OL< realT >::evaluations { 0 }

Objective evaluations performed.

Definition at line 1415 of file clGainOpt.hpp.

Referenced by operator()(), and mx::AO::analysis::clGainOpt< _realT >::optGainOpenLoop().

◆ go

template<typename realT>
clGainOpt<realT>* mx::AO::analysis::clGainOptOptGain_OL< realT >::go { nullptr }

Gain optimizer used to evaluate variance.

Definition at line 1412 of file clGainOpt.hpp.

Referenced by operator()(), and mx::AO::analysis::clGainOpt< _realT >::optGainOpenLoop().

◆ maximumEvaluatedGain

template<typename realT>
realT mx::AO::analysis::clGainOptOptGain_OL< realT >::maximumEvaluatedGain { std::numeric_limits<realT>::lowest() }

Largest gain evaluated.

Definition at line 1417 of file clGainOpt.hpp.

Referenced by operator()(), and mx::AO::analysis::clGainOpt< _realT >::optGainOpenLoop().

◆ minimumEvaluatedGain

template<typename realT>
realT mx::AO::analysis::clGainOptOptGain_OL< realT >::minimumEvaluatedGain { std::numeric_limits<realT>::max() }

Smallest gain evaluated.

Definition at line 1416 of file clGainOpt.hpp.

Referenced by operator()(), and mx::AO::analysis::clGainOpt< _realT >::optGainOpenLoop().

◆ PSDerr

template<typename realT>
const std::vector<realT>* mx::AO::analysis::clGainOptOptGain_OL< realT >::PSDerr { nullptr }

Open-loop disturbance PSD.

Definition at line 1413 of file clGainOpt.hpp.

Referenced by operator()(), and mx::AO::analysis::clGainOpt< _realT >::optGainOpenLoop().

◆ PSDnoise

template<typename realT>
const std::vector<realT>* mx::AO::analysis::clGainOptOptGain_OL< realT >::PSDnoise { nullptr }

Measurement-noise PSD.

Definition at line 1414 of file clGainOpt.hpp.

Referenced by operator()(), and mx::AO::analysis::clGainOpt< _realT >::optGainOpenLoop().


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