mxlib
c++ tools for analyzing astronomical data and other tasks by Jared R. Males. [git repo]
Loading...
Searching...
No Matches
aoSystem_test.cpp
Go to the documentation of this file.
1/** \file aoSystem_test.cpp
2 */
3#include "../../../catch2/catch.hpp"
4
5#define MX_NO_ERROR_REPORTS
6
7#include "../../../../include/ao/analysis/aoSystem.hpp"
8
9typedef double realT;
10
11using namespace mx::app;
12using namespace mx::AO::analysis;
13
14/** Scenario: Loading aoSystem config settings
15 *
16 * Verify parsing of config
17 * \anchor tests_ao_analysis_aoSystem_config
18 */
19SCENARIO( "Loading aoSystem config settings", "[ao::analysis::aoSystem]" )
20{
21 GIVEN( "no config file" )
22 {
23 aoSystem<realT, mx::AO::analysis::vonKarmanSpectrum<realT>> aosys; // This will be cumulative
24 WHEN( "verifying the defaults" )
25 {
26
27 REQUIRE( aosys.D() == 0.0 );
28 REQUIRE( aosys.d_min( 0 ) == 0.0 );
29 REQUIRE( aosys.d_opt() == 1e-50 );
30 REQUIRE( aosys.optd() == false );
31 REQUIRE( aosys.optd_delta() == 1.0 );
32 REQUIRE( aosys.wfsBeta()->_id == "Ideal WFS" );
33 REQUIRE( aosys.lam_wfs() == 0 );
34 REQUIRE( aosys.npix_wfs().size() == 1 );
35 REQUIRE( aosys.npix_wfs( (size_t)0 ) == 0 );
36 REQUIRE( aosys.ron_wfs().size() == 1 );
37 REQUIRE( aosys.ron_wfs( (size_t)0 ) == 0 );
38 REQUIRE( aosys.Fbg().size() == 1 );
39 REQUIRE( aosys.Fbg( (size_t)0 ) == 0 );
40 REQUIRE( aosys.minTauWFS().size() == 1 );
41 REQUIRE( aosys.minTauWFS( (size_t)0 ) == 0 );
42 REQUIRE( aosys.bin_npix() == true );
43 REQUIRE( aosys.tauWFS() == 0 );
44 REQUIRE( aosys.deltaTau() == 0 );
45 REQUIRE( aosys.optTau() == true );
46 REQUIRE( aosys.lam_sci() == 0 );
47 REQUIRE( aosys.zeta() == 0 );
48 REQUIRE( aosys.secZeta() == 1.0 );
49 REQUIRE( aosys.fit_mn_max() == 100 );
50 REQUIRE( aosys.circularLimit() == false );
51 REQUIRE( aosys.spatialFilter_ku() == std::numeric_limits<realT>::max() );
52 REQUIRE( aosys.spatialFilter_kv() == std::numeric_limits<realT>::max() );
53 REQUIRE( aosys.ncp_wfe() == 0 );
54 REQUIRE( aosys.ncp_alpha() == 2.0 );
55 REQUIRE( aosys.F0() == 0.0 );
56 REQUIRE( aosys.starMag() == 0 );
57 REQUIRE( aosys.Fg() == 0 );
58 REQUIRE( aosys.Fg( 2.5 ) == 0 );
59 }
60 }
61
62 GIVEN( "a valid config file" )
63 {
64 aoSystem<realT, mx::AO::analysis::vonKarmanSpectrum<realT>> aosys; // This will be cumulative
65
66 WHEN( "setting wfs to ideal" )
67 {
68 appConfigurator config;
69
70 writeConfigFile( "aoSystem.conf", { "aosys" }, { "wfs" }, { "ideal" } );
71
72 aosys.setupConfig( config );
73 config.readConfig( "aoSystem.conf" );
74 aosys.loadConfig( config );
75
76 REQUIRE( aosys.wfsBeta()->_id == "Ideal WFS" );
77 }
78 WHEN( "setting wfs to unmodPyWFS" )
79 {
80 appConfigurator config;
81
82 writeConfigFile( "aoSystem.conf", { "aosys" }, { "wfs" }, { "unmodPyWFS" } );
83
84 aosys.setupConfig( config );
85 config.readConfig( "aoSystem.conf" );
86
87 aosys.loadConfig( config );
88
89 REQUIRE( aosys.wfsBeta()->_id == "Unmodulated Pyramid" );
90 }
91 WHEN( "setting wfs to asympModPyWFS" )
92 {
93 appConfigurator config;
94
95 writeConfigFile( "aoSystem.conf", { "aosys" }, { "wfs" }, { "asympModPyWFS" } );
96
97 aosys.setupConfig( config );
98 config.readConfig( "aoSystem.conf" );
99 aosys.loadConfig( config );
100
101 REQUIRE( aosys.wfsBeta()->_id == "Asymptotic Modulated Pyramid" );
102 }
103 WHEN( "setting wfs to SHWFS" )
104 {
105 appConfigurator config;
106
107 writeConfigFile( "aoSystem.conf", { "aosys" }, { "wfs" }, { "SHWFS" } );
108
109 aosys.setupConfig( config );
110 config.readConfig( "aoSystem.conf" );
111 aosys.loadConfig( config );
112
113 REQUIRE( aosys.wfsBeta()->_id == "Shack Hartmann" );
114 }
115 WHEN( "typical settings part 1" ) // These are broken into parts just to keep things < 1 line
116 {
117 appConfigurator config;
118
119 writeConfigFile( "aoSystem.conf",
120 { "aosys", "aosys", "aosys", "aosys", "aosys" },
121 { "D", "d_min", "optd", "optd_delta", "lam_wfs" },
122 { "7.6", "0.122", "true", "0.0037", "800e-9" } );
123
124 aosys.setupConfig( config );
125 config.readConfig( "aoSystem.conf" );
126 aosys.loadConfig( config );
127
128 REQUIRE( aosys.D() == Approx( 7.6 ) );
129 REQUIRE( aosys.d_min( 0 ) == Approx( 0.122 ) );
130 REQUIRE( aosys.optd() == true );
131 REQUIRE( aosys.optd_delta() == Approx( 0.0037 ) );
132 REQUIRE( aosys.lam_wfs() == Approx( 800e-9 ) );
133 }
134 WHEN( "typical settings part 2" )
135 {
136 appConfigurator config;
137
138 writeConfigFile( "aoSystem.conf",
139 { "aosys", "aosys", "aosys", "aosys", "aosys" },
140 { "npix_wfs", "ron_wfs", "Fbg", "minTauWFS", "bin_npix" },
141 { "100,1001", "0.5,0.25", "0.01,0.03", "0.0001,0.0005", "false" } );
142
143 aosys.setupConfig( config );
144 config.readConfig( "aoSystem.conf" );
145 aosys.loadConfig( config );
146
147 REQUIRE( aosys.npix_wfs( 0 ) == 100 );
148 REQUIRE( aosys.npix_wfs( 1 ) == 1001 );
149 REQUIRE( aosys.ron_wfs( 0 ) == 0.5 );
150 REQUIRE( aosys.ron_wfs( 1 ) == 0.25 );
151 REQUIRE( aosys.Fbg( 0 ) == 0.01 );
152 REQUIRE( aosys.Fbg( 1 ) == 0.03 );
153 REQUIRE( aosys.minTauWFS( 0 ) == 0.0001 );
154 REQUIRE( aosys.minTauWFS( 1 ) == 0.0005 );
155 REQUIRE( aosys.bin_npix() == false );
156 }
157 WHEN( "typical settings part 3" )
158 {
159 appConfigurator config;
160
161 writeConfigFile( "aoSystem.conf",
162 { "aosys", "aosys", "aosys", "aosys", "aosys", "aosys", "aosys", "aosys", "aosys" },
163 { "tauWFS",
164 "deltaTau",
165 "optTau",
166 "lam_sci",
167 "zeta",
168 "fit_mn_max",
169 "circularLimit",
170 "spatialFilter_ku",
171 "spatialFilter_kv" },
172 { "0.0007", "0.0001", "false", "802e-9", "0.15", "12", "true", "50", "53" } );
173
174 aosys.setupConfig( config );
175 config.readConfig( "aoSystem.conf" );
176 aosys.loadConfig( config );
177
178 REQUIRE( aosys.tauWFS() == Approx( 0.0007 ) );
179 REQUIRE( aosys.deltaTau() == Approx( 0.0001 ) );
180 REQUIRE( aosys.optTau() == false );
181 REQUIRE( aosys.lam_sci() == Approx( 802e-9 ) );
182 REQUIRE( aosys.zeta() == Approx( 0.15 ) );
183 REQUIRE( aosys.secZeta() == Approx( 1 / cos( 0.15 ) ) );
184 REQUIRE( aosys.fit_mn_max() == 12 );
185 REQUIRE( aosys.circularLimit() == true );
186 REQUIRE( aosys.spatialFilter_ku() == 50 );
187 REQUIRE( aosys.spatialFilter_kv() == 53 );
188 }
189 WHEN( "typical settings part 4" )
190 {
191 appConfigurator config;
192
193 writeConfigFile(
194 "aoSystem.conf",
195 { "aosys", "aosys", "aosys", "aosys", "atm" }, // last one verifies that atm config gets processed
196 { "ncp_wfe", "ncp_alpha", "starMag", "F0", "r_0" },
197 { "30e-9", "2.34", "8.2", "5e9", "0.25" } );
198
199 aosys.setupConfig( config );
200 config.readConfig( "aoSystem.conf" );
201 aosys.loadConfig( config );
202
203 REQUIRE( aosys.ncp_wfe() == Approx( 30e-9 ) );
204 REQUIRE( aosys.ncp_alpha() == Approx( 2.34 ) );
205 REQUIRE( aosys.F0() == Approx( 5e9 ) );
206 REQUIRE( aosys.starMag() == Approx( 8.2 ) );
207 REQUIRE( aosys.Fg() == Approx( 5e9 * pow( 10, -0.4 * 8.2 ) ) );
208 REQUIRE( aosys.Fg( 9.0 ) == Approx( 5e9 * pow( 10, -0.4 * 9.0 ) ) );
209 REQUIRE( aosys.atm.r_0() == Approx( 0.25 ) );
210 }
211 }
212}
SCENARIO
SCENARIO("Loading aoSystem config settings", "[ao::analysis::aoSystem]")
Definition aoSystem_test.cpp:19
mx::app::writeConfigFile
void writeConfigFile(const std::string &fname, const std::vector< std::string > &sections, const std::vector< std::string > &keywords, const std::vector< std::string > &values)
A simple config file writing function, useful for testing.
Definition appConfigurator.cpp:892
mx::AO::analysis::aoAtmosphere::r_0
realT r_0()
Get the value of Fried's parameter r_0 at the reference wavelength lam_0.
Definition aoAtmosphere.hpp:661
mx::AO::analysis::aoSystem
Describes an analytic adaptive optics (AO) system.
Definition aoSystem.hpp:65
mx::AO::analysis::aoSystem::optTau
void optTau(bool ot)
Set the value of m_optTau.
Definition aoSystem.hpp:1650
mx::AO::analysis::aoSystem::optd_delta
void optd_delta(realT odd)
Set the fractional change in actuator spacing for optimization.
Definition aoSystem.hpp:1320
mx::AO::analysis::aoSystem::starMag
void starMag(realT nmag)
Set the value of the Star's magnitude.
Definition aoSystem.hpp:1798
mx::AO::analysis::aoSystem::wfsBeta
void wfsBeta(const wfsT &w)
Set the WFS Beta pointer.
Definition aoSystem.hpp:1335
mx::AO::analysis::aoSystem::circularLimit
void circularLimit(bool cl)
Set the value of the circularLimit flag.
Definition aoSystem.hpp:1714
mx::AO::analysis::aoSystem::ncp_alpha
void ncp_alpha(realT alpha)
Set the value of the non-common path WFE PSD index.
Definition aoSystem.hpp:1770
mx::AO::analysis::aoSystem::d_opt
realT d_opt()
Calculate the optimum actuator spacing.
Definition aoSystem.hpp:2113
mx::AO::analysis::aoSystem::tauWFS
void tauWFS(realT ntau)
Set the value of the WFS exposure time.
Definition aoSystem.hpp:1622
mx::AO::analysis::aoSystem::deltaTau
void deltaTau(realT ndel)
Set the value of m_deltaTau.
Definition aoSystem.hpp:1636
mx::AO::analysis::aoSystem::minTauWFS
void minTauWFS(const std::vector< realT > &ntau)
Set the value of the minimum WFS exposure times.
Definition aoSystem.hpp:1554
mx::AO::analysis::aoSystem::D
void D(realT nD)
Set the value of the primary mirror diameter.
Definition aoSystem.hpp:1251
mx::AO::analysis::aoSystem::spatialFilter_ku
void spatialFilter_ku(realT ku)
Set the value of spatialFilter_ku.
Definition aoSystem.hpp:1728
mx::AO::analysis::aoSystem::npix_wfs
void npix_wfs(const std::vector< realT > &npix)
Set the number of pixels in the WFS for each WFS mode.
Definition aoSystem.hpp:1422
mx::AO::analysis::aoSystem::optd
void optd(bool od)
Set whether or not the value of d is optimized or just set to m_d_min.
Definition aoSystem.hpp:1306
mx::AO::analysis::aoSystem::secZeta
realT secZeta()
Get the zecant of the zenith angle.
Definition aoSystem.hpp:1694
mx::AO::analysis::aoSystem::lam_wfs
void lam_wfs(realT nlam)
Set the value of the WFS wavelength.
Definition aoSystem.hpp:1408
mx::AO::analysis::aoSystem::bin_npix
void bin_npix(bool bnp)
Set the value of the pixel binning flag.
Definition aoSystem.hpp:1598
mx::AO::analysis::aoSystem::ron_wfs
void ron_wfs(const std::vector< realT > &nron)
Set the value of the WFS readout noise for each WFS mode.
Definition aoSystem.hpp:1466
mx::AO::analysis::aoSystem::Fg
realT Fg(realT mag)
The photon flux at a given star magnitude.
Definition aoSystem.hpp:1812
mx::AO::analysis::aoSystem::F0
void F0(realT nF0)
Set the value of the 0 magnitude photon rate.
Definition aoSystem.hpp:1784
mx::AO::analysis::aoSystem::d_min
void d_min(const std::vector< realT > &nd)
Set the minimum subaperture sampling for each WFS mode.
Definition aoSystem.hpp:1267
mx::AO::analysis::aoSystem::setupConfig
void setupConfig(app::appConfigurator &config)
Setup the configurator to configure this class.
Definition aoSystem.hpp:2792
mx::AO::analysis::aoSystem::lam_sci
void lam_sci(realT nlam)
Set the science wavelength.
Definition aoSystem.hpp:1664
mx::AO::analysis::aoSystem::zeta
void zeta(realT nz)
Set the zenith angle, and its secant.
Definition aoSystem.hpp:1678
mx::AO::analysis::aoSystem::fit_mn_max
void fit_mn_max(int mnm)
Set the value of m_fit_mn_max.
Definition aoSystem.hpp:1700
mx::AO::analysis::aoSystem::ncp_wfe
void ncp_wfe(realT nwfe)
Set the value of the non-common path WFE.
Definition aoSystem.hpp:1756
mx::AO::analysis::aoSystem::Fbg
void Fbg(const std::vector< realT > &fbg)
Set the value of the background fluxes.
Definition aoSystem.hpp:1510
mx::AO::analysis::aoSystem::spatialFilter_kv
void spatialFilter_kv(realT kv)
Set the value of spatialFilter_kv.
Definition aoSystem.hpp:1742
mx::AO::analysis::aoSystem::loadConfig
void loadConfig(app::appConfigurator &config)
Load the configuration of this class from a configurator.
Definition aoSystem.hpp:3035
mx::app::appConfigurator
Class to manage a set of configurable values, and read their values from config/ini files and the com...
Definition appConfigurator.hpp:86
mx::app::appConfigurator::readConfig
int readConfig(const std::string &fname, bool reportFileNotFound=true)
Read and parse a config/ini file, updating the targets.
Definition appConfigurator.cpp:149