mxlib
c++ tools for analyzing astronomical data and other tasks by Jared R. Males. [git repo]
Loading...
Searching...
No Matches
Functions
mx::AO::path::dm Namespace Reference

Functions

std::string root (const std::string &dmName, bool create=false)
 The root path for deformable mirror (DM) files.
 
std::string influenceFunctions (const std::string &dmName, bool create=false)
 The path for the deformable mirror (DM) influence functions.
 
std::string actuatorPositions (const std::string &dmName, bool create=false)
 The path for the deformable mirror (DM) actuator positions.
 
std::string pseudoInverse (const std::string &dmName, bool create=false)
 The path for the deformable mirror (DM) influence function pseudo-inverse.
 
std::string mirrorModes (const std::string &dmName, bool create=false)
 The path for the deformable mirror (DM) influence function based mirror modes.
 
std::string singularValues (const std::string &dmName, bool create=false)
 The path for the deformable mirror (DM) influence function pseudo-inverse singular values.
 
std::string basisRoot (const std::string &dmName, const std::string &basisName, bool create=false)
 The root path for the deformable mirror (DM) basis related files.
 
std::string M2c (const std::string &dmName, const std::string &basisName, bool create=false)
 The path for the modes-to-commands (M2c) matrix for a deformable mirror (DM) and a basis set.
 
std::string projectedModes (const std::string &dmName, const std::string &basisName, bool create=false)
 The path for the projected modes for a deformable mirror (DM) and a basis set.
 

Function Documentation

◆ actuatorPositions()

std::string mx::AO::path::dm::actuatorPositions ( const std::string &  dmName,
bool  create = false 
)

The path for the deformable mirror (DM) actuator positions.

Parameters
[in]dmNamethe name of the DM
[in]create[optional] create the root directory if it noes not exist.
Returns
the path to the FITS file containing the DM actuator positions

Definition at line 118 of file aoPaths.hpp.

References root().

Referenced by mx::AO::influenceFunctionGaussianSpec< realT >::influenceFunctionsGaussian(), mx::AO::influenceFunctionsGaussian(), and mx::AO::sim::deformableMirror< _realT >::initialize().

◆ basisRoot()

std::string mx::AO::path::dm::basisRoot ( const std::string &  dmName,
const std::string &  basisName,
bool  create = false 
)

The root path for the deformable mirror (DM) basis related files.

Parameters
[in]dmNamethe name of the DM
[in]basisNamethe name of the basis set
[in]create[optional] create the root directory if it noes not exist.
Returns
the root path for the DM basis related files

Definition at line 175 of file aoPaths.hpp.

References mx::ioutils::createDirectories(), and root().

Referenced by M2c(), and projectedModes().

◆ influenceFunctions()

std::string mx::AO::path::dm::influenceFunctions ( const std::string &  dmName,
bool  create = false 
)

The path for the deformable mirror (DM) influence functions.

Parameters
[in]dmNamethe name of the DM
[in]create[optional] create the root directory if it noes not exist.
Returns
the path to the FITS file containing the DM influence functions.

Definition at line 104 of file aoPaths.hpp.

References root().

Referenced by mx::AO::ifPInv(), mx::AO::influenceFunctionGaussianSpec< realT >::influenceFunctionsGaussian(), mx::AO::influenceFunctionsGaussian(), mx::AO::sim::deformableMirror< _realT >::initialize(), mx::AO::modesOnDM(), and mx::AO::slaveBasis().

◆ M2c()

std::string mx::AO::path::dm::M2c ( const std::string &  dmName,
const std::string &  basisName,
bool  create = false 
)

The path for the modes-to-commands (M2c) matrix for a deformable mirror (DM) and a basis set.

Parameters
[in]dmNamethe name of the DM
[in]basisNamethe name of the basis set
[in]create[optional] create the root directory if it noes not exist.
Returns
the path to the FITS file containting the M2c matrix for a DM and a basis set.

Definition at line 195 of file aoPaths.hpp.

References basisRoot(), and mx::ioutils::createDirectories().

Referenced by mx::AO::sim::deformableMirror< _realT >::initialize(), mx::AO::m2cMatrix(), mx::AO::modalDMM2cMatrix(), and mx::AO::modesOnDM().

◆ mirrorModes()

std::string mx::AO::path::dm::mirrorModes ( const std::string &  dmName,
bool  create = false 
)

The path for the deformable mirror (DM) influence function based mirror modes.

Parameters
[in]dmNamethe name of the DM
[in]create[optional] create the root directory if it noes not exist.
Returns
the path to the FITS file containing the DM influence function based mirror modes

Definition at line 146 of file aoPaths.hpp.

References mx::AO::path::basis::modes().

Referenced by mx::AO::ifPInv().

◆ projectedModes()

std::string mx::AO::path::dm::projectedModes ( const std::string &  dmName,
const std::string &  basisName,
bool  create = false 
)

The path for the projected modes for a deformable mirror (DM) and a basis set.

These are the modes as reproduced by the DM actuators.

Parameters
[in]dmNamethe name of the DM
[in]basisNamethe name of the basis set
[in]pupilNamethe name of the pupil
[in]create[optional] create the root directory if it noes not exist.
Returns
the path to the FITS file containting the M2c matrix for a DM and a basis set.

Definition at line 245 of file aoPaths.hpp.

References basisRoot(), and mx::ioutils::createDirectories().

Referenced by mx::AO::modesOnDM().

◆ pseudoInverse()

std::string mx::AO::path::dm::pseudoInverse ( const std::string &  dmName,
bool  create = false 
)

The path for the deformable mirror (DM) influence function pseudo-inverse.

Parameters
[in]dmNamethe name of the DM
[in]create[optional] create the root directory if it noes not exist.
Returns
the path to the FITS file containing the DM influence function pseudo-inverse matrix

Definition at line 132 of file aoPaths.hpp.

References root().

Referenced by mx::AO::ifPInv(), and mx::AO::m2cMatrix().

◆ root()

std::string mx::AO::path::dm::root ( const std::string &  dmName,
bool  create = false 
)

The root path for deformable mirror (DM) files.

Parameters
[in]dmNamethe name of the DM
[in]create[optional] create the directory if it noes not exist.
Returns
the root path for DM files.

Definition at line 83 of file aoPaths.hpp.

References mx::ioutils::createDirectories(), and mx::sys::getEnv().

Referenced by actuatorPositions(), basisRoot(), influenceFunctions(), pseudoInverse(), and singularValues().

◆ singularValues()

std::string mx::AO::path::dm::singularValues ( const std::string &  dmName,
bool  create = false 
)

The path for the deformable mirror (DM) influence function pseudo-inverse singular values.

Parameters
[in]dmNamethe name of the DM
[in]create[optional] create the root directory if it noes not exist.
Returns
the path to the FITS file containing the DM influence function pseudo-inverse singular values

Definition at line 160 of file aoPaths.hpp.

References root().

Referenced by mx::AO::ifPInv().