mxlib
c++ tools for analyzing astronomical data and other tasks by Jared R. Males. [git repo]
Loading...
Searching...
No Matches
List of all members | Public Types | Public Member Functions | Public Attributes
mx::AO::sim::turbSequence< _realT > Struct Template Reference

template<typename _realT>
struct mx::AO::sim::turbSequence< _realT >

Definition at line 30 of file turbSequence.hpp.

#include <ao/sim/turbSequence.hpp>

Public Types

typedef _realT realT
 
typedef Eigen::Array< realT, Eigen::Dynamic, Eigen::Dynamic > imageT
 

Public Member Functions

 turbSequence ()
 
int size ()
 Return the size of the turbulence screens.
 
int nPerCube ()
 Return the number of frames per cube.
 
int files ()
 Return the number of files.
 
int frames ()
 Return the number of frames in each file.
 
realT wfPS ()
 
void wfPS (realT ps)
 
realT F0Photons ()
 
void F0Photons (realT f0)
 
realT starMag ()
 
void starMag (realT sm)
 
realT pixVal ()
 
void calcPixVal ()
 
int turbFnames (std::string dir, int max=0)
 Get the file names of the sequence assuming they are stored in a directory.
 
void openPhaseFrame (int fn)
 
void nextPhase (wavefront< realT > &wf)
 
void nextWF (wavefront< realT > &wf)
 

Public Attributes

std::vector< std::string > _phaseFnames
 
std::vector< std::string > _ampFnames
 
int _size { 0 }
 
int _nPerCube { 0 }
 
int _files { 0 }
 
int _frames { 0 }
 
int _currFileNo { 0 }
 
int _currFrameNo { 0 }
 
realT _wfPS { 1 }
 
realT _F0Photons { 2e11 }
 
realT _starMag { 0 }
 
realT _pixVal
 
imageT * _pupil
 
bool _loopClosed
 
improc::eigenCube< realT > _currPhase
 
improc::eigenCube< realT > _currAmp
 
bool _phaseOnly { false }
 

Member Typedef Documentation

◆ imageT

template<typename _realT >
typedef Eigen::Array<realT, Eigen::Dynamic, Eigen::Dynamic> mx::AO::sim::turbSequence< _realT >::imageT

Definition at line 33 of file turbSequence.hpp.

◆ realT

template<typename _realT >
typedef _realT mx::AO::sim::turbSequence< _realT >::realT

Definition at line 32 of file turbSequence.hpp.

Constructor & Destructor Documentation

◆ turbSequence()

template<typename _realT >
mx::AO::sim::turbSequence< _realT >::turbSequence ( )
inline

Definition at line 65 of file turbSequence.hpp.

Member Function Documentation

◆ calcPixVal()

template<typename _realT >
void mx::AO::sim::turbSequence< _realT >::calcPixVal ( )
inline

Definition at line 143 of file turbSequence.hpp.

References mx::AO::sim::turbSequence< _realT >::_F0Photons, mx::AO::sim::turbSequence< _realT >::_pixVal, mx::AO::sim::turbSequence< _realT >::_starMag, and mx::AO::sim::turbSequence< _realT >::_wfPS.

Referenced by mx::AO::sim::turbSequence< _realT >::F0Photons(), mx::AO::sim::turbSequence< _realT >::starMag(), and mx::AO::sim::turbSequence< _realT >::wfPS().

◆ F0Photons() [1/2]

template<typename _realT >
realT mx::AO::sim::turbSequence< _realT >::F0Photons ( )
inline

Definition at line 116 of file turbSequence.hpp.

References mx::AO::sim::turbSequence< _realT >::_F0Photons.

◆ F0Photons() [2/2]

template<typename _realT >
void mx::AO::sim::turbSequence< _realT >::F0Photons ( realT  f0)
inline

Definition at line 121 of file turbSequence.hpp.

References mx::AO::sim::turbSequence< _realT >::_F0Photons, and mx::AO::sim::turbSequence< _realT >::calcPixVal().

◆ files()

template<typename _realT >
int mx::AO::sim::turbSequence< _realT >::files ( )
inline

Return the number of files.

Returns
_files

Definition at line 91 of file turbSequence.hpp.

References mx::AO::sim::turbSequence< _realT >::_files.

◆ frames()

template<typename _realT >
int mx::AO::sim::turbSequence< _realT >::frames ( )
inline

Return the number of frames in each file.

Returns
_frames

Definition at line 100 of file turbSequence.hpp.

References mx::AO::sim::turbSequence< _realT >::_frames.

◆ nextPhase()

template<typename realT >
void mx::AO::sim::turbSequence< realT >::nextPhase ( wavefront< realT > &  wf)

Definition at line 223 of file turbSequence.hpp.

References mx::AO::sim::wavefront< _realT >::amplitude, and mx::AO::sim::wavefront< _realT >::phase.

◆ nextWF()

template<typename realT >
void mx::AO::sim::turbSequence< realT >::nextWF ( wavefront< realT > &  wf)

Definition at line 252 of file turbSequence.hpp.

References mx::AO::sim::wavefront< _realT >::amplitude, and mx::AO::sim::wavefront< _realT >::phase.

◆ nPerCube()

template<typename _realT >
int mx::AO::sim::turbSequence< _realT >::nPerCube ( )
inline

Return the number of frames per cube.

Returns
_nPerCube

Definition at line 82 of file turbSequence.hpp.

References mx::AO::sim::turbSequence< _realT >::_nPerCube.

◆ openPhaseFrame()

template<typename realT >
void mx::AO::sim::turbSequence< realT >::openPhaseFrame ( int  fn)

Definition at line 203 of file turbSequence.hpp.

References mx::fits::fitsFile< dataT >::close(), and mx::fits::fitsFile< dataT >::read().

◆ pixVal()

template<typename _realT >
realT mx::AO::sim::turbSequence< _realT >::pixVal ( )
inline

Definition at line 138 of file turbSequence.hpp.

References mx::AO::sim::turbSequence< _realT >::_pixVal.

◆ size()

template<typename _realT >
int mx::AO::sim::turbSequence< _realT >::size ( )
inline

Return the size of the turbulence screens.

Returns
_size

Definition at line 73 of file turbSequence.hpp.

References mx::AO::sim::turbSequence< _realT >::_size.

◆ starMag() [1/2]

template<typename _realT >
realT mx::AO::sim::turbSequence< _realT >::starMag ( )
inline

Definition at line 127 of file turbSequence.hpp.

References mx::AO::sim::turbSequence< _realT >::_starMag.

◆ starMag() [2/2]

template<typename _realT >
void mx::AO::sim::turbSequence< _realT >::starMag ( realT  sm)
inline

Definition at line 132 of file turbSequence.hpp.

References mx::AO::sim::turbSequence< _realT >::_starMag, and mx::AO::sim::turbSequence< _realT >::calcPixVal().

◆ turbFnames()

template<typename realT >
int mx::AO::sim::turbSequence< realT >::turbFnames ( std::string  dir,
int  max = 0 
)

Get the file names of the sequence assuming they are stored in a directory.

Parameters
[in]diris the directory to search for phase and amplitude files.
[in]max[optional] specifies the maximum number of files to include the file name list.
Return values
0on success.
-1on error.

Definition at line 167 of file turbSequence.hpp.

References mx::ioutils::getFileNames(), MXE_FILENOTFOUND, and mxError.

◆ wfPS() [1/2]

template<typename _realT >
realT mx::AO::sim::turbSequence< _realT >::wfPS ( )
inline

Definition at line 105 of file turbSequence.hpp.

References mx::AO::sim::turbSequence< _realT >::_wfPS.

◆ wfPS() [2/2]

template<typename _realT >
void mx::AO::sim::turbSequence< _realT >::wfPS ( realT  ps)
inline

Definition at line 110 of file turbSequence.hpp.

References mx::AO::sim::turbSequence< _realT >::_wfPS, and mx::AO::sim::turbSequence< _realT >::calcPixVal().

Member Data Documentation

◆ _ampFnames

template<typename _realT >
std::vector<std::string> mx::AO::sim::turbSequence< _realT >::_ampFnames

Definition at line 36 of file turbSequence.hpp.

◆ _currAmp

template<typename _realT >
improc::eigenCube<realT> mx::AO::sim::turbSequence< _realT >::_currAmp

Definition at line 61 of file turbSequence.hpp.

◆ _currFileNo

template<typename _realT >
int mx::AO::sim::turbSequence< _realT >::_currFileNo { 0 }

Definition at line 46 of file turbSequence.hpp.

◆ _currFrameNo

template<typename _realT >
int mx::AO::sim::turbSequence< _realT >::_currFrameNo { 0 }

Definition at line 47 of file turbSequence.hpp.

◆ _currPhase

template<typename _realT >
improc::eigenCube<realT> mx::AO::sim::turbSequence< _realT >::_currPhase

Definition at line 60 of file turbSequence.hpp.

◆ _F0Photons

template<typename _realT >
realT mx::AO::sim::turbSequence< _realT >::_F0Photons { 2e11 }

Definition at line 50 of file turbSequence.hpp.

Referenced by mx::AO::sim::turbSequence< _realT >::calcPixVal(), mx::AO::sim::turbSequence< _realT >::F0Photons(), and mx::AO::sim::turbSequence< _realT >::F0Photons().

◆ _files

template<typename _realT >
int mx::AO::sim::turbSequence< _realT >::_files { 0 }

Definition at line 42 of file turbSequence.hpp.

Referenced by mx::AO::sim::turbSequence< _realT >::files().

◆ _frames

template<typename _realT >
int mx::AO::sim::turbSequence< _realT >::_frames { 0 }

Definition at line 44 of file turbSequence.hpp.

Referenced by mx::AO::sim::turbSequence< _realT >::frames().

◆ _loopClosed

template<typename _realT >
bool mx::AO::sim::turbSequence< _realT >::_loopClosed

Definition at line 58 of file turbSequence.hpp.

◆ _nPerCube

template<typename _realT >
int mx::AO::sim::turbSequence< _realT >::_nPerCube { 0 }

Definition at line 40 of file turbSequence.hpp.

Referenced by mx::AO::sim::turbSequence< _realT >::nPerCube().

◆ _phaseFnames

template<typename _realT >
std::vector<std::string> mx::AO::sim::turbSequence< _realT >::_phaseFnames

Definition at line 35 of file turbSequence.hpp.

◆ _phaseOnly

template<typename _realT >
bool mx::AO::sim::turbSequence< _realT >::_phaseOnly { false }

Definition at line 63 of file turbSequence.hpp.

◆ _pixVal

template<typename _realT >
realT mx::AO::sim::turbSequence< _realT >::_pixVal

Definition at line 54 of file turbSequence.hpp.

Referenced by mx::AO::sim::turbSequence< _realT >::calcPixVal(), and mx::AO::sim::turbSequence< _realT >::pixVal().

◆ _pupil

template<typename _realT >
imageT* mx::AO::sim::turbSequence< _realT >::_pupil

Definition at line 56 of file turbSequence.hpp.

◆ _size

template<typename _realT >
int mx::AO::sim::turbSequence< _realT >::_size { 0 }

Definition at line 38 of file turbSequence.hpp.

Referenced by mx::AO::sim::turbSequence< _realT >::size().

◆ _starMag

template<typename _realT >
realT mx::AO::sim::turbSequence< _realT >::_starMag { 0 }

Definition at line 52 of file turbSequence.hpp.

Referenced by mx::AO::sim::turbSequence< _realT >::calcPixVal(), mx::AO::sim::turbSequence< _realT >::starMag(), and mx::AO::sim::turbSequence< _realT >::starMag().

◆ _wfPS

template<typename _realT >
realT mx::AO::sim::turbSequence< _realT >::_wfPS { 1 }

Definition at line 49 of file turbSequence.hpp.

Referenced by mx::AO::sim::turbSequence< _realT >::calcPixVal(), mx::AO::sim::turbSequence< _realT >::wfPS(), and mx::AO::sim::turbSequence< _realT >::wfPS().

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