mx::AO::path::pupil Namespace Reference

Functions
std::string	root (const std::string &pupilName, bool create=false)
	The root path for pupil files.
std::string	pupilFile (const std::string &pupilName, bool create=false)
	The path for the pupil FITS file.

Function Documentation

pupilFile()

std::string mx::AO::path::pupil::pupilFile	(	const std::string &	pupilName,
		bool	create = false
	)

The path for the pupil FITS file.

Parameters

[in]	pupilName	the name of the pupil file
[in]	create	[optional] create the root directory if it noes not exist.

Returns

the path to the FITS file containing the pupil as a 1/0 mask

Definition at line 323 of file aoPaths.hpp.

References root().

Referenced by mx::AO::applyPupil2Basis(), mx::AO::circularApodizedPupil(), mx::AO::circularPupil(), mx::AO::sim::deformableMirror< _realT >::initialize(), mx::AO::sim::simulatedAOSystem< _realT, _wfsT, _reconT, _filterT, _dmT, _turbSeqT, _coronT >::initSystem(), mx::AO::makeZernikeBasis(), mx::AO::orthogonalizeBasis(), mx::AO::slaveBasis(), and mx::AO::subtractBasis().

root()

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

The root path for pupil files.

Parameters

[in]	pupilName	the name of the basis
[in]	create	[optional] create the directory if it noes not exist.

Returns

the root path for pupil files.

Definition at line 301 of file aoPaths.hpp.

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

Referenced by pupilFile().