pupil.hpp File Reference

Utilities for specifying pupils. More...

Utilities for specifying pupils.

Author

Jared R. Males (jared.nosp@m.male.nosp@m.s@gma.nosp@m.il.c.nosp@m.om)

Definition in file pupil.hpp.

#include "../ioutils/fits/fitsFile.hpp"
#include "../improc/eigenImage.hpp"
#include "../wfp/imagingUtils.hpp"
#include "../sigproc/signalWindows.hpp"
#include "aoPaths.hpp"

Go to the source code of this file.

Namespaces
namespace	mx
	The mxlib c++ namespace.

Functions
template<typename realT>
void	mx::AO::circularPupil (const std::string &pupilName, realT pupilDiamPixels, realT pupilDiamMeters, realT centralObs=0, realT overscan=0)
	Generate a circular pupil and saves it to disk.
template<typename realT>
void	mx::AO::circularApodizedPupil (const std::string &pupilName, int pupilDiamPixels, realT pupilDiamMeters, realT tukeyAlpha, realT centralObs=0, realT overScan=0)
	Generates a circular apodized pupil and saves it to disk.

Function Documentation

circularApodizedPupil()

template<typename realT>

void mx::AO::circularApodizedPupil	(	const std::string &	pupilName,
		int	pupilDiamPixels,
		realT	pupilDiamMeters,
		realT	tukeyAlpha,
		realT	centralObs = 0,
		realT	overScan = 0 )

Generates a circular apodized pupil and saves it to disk.

Apodization is with a Tukey window.

Definition at line 62 of file pupil.hpp.

References mx::fits::fitsHeader< verboseT >::append(), mx::sigproc::window::tukey2d(), mx::sigproc::window::tukey2dAnnulus(), and mx::fits::fitsFile< dataT, verboseT >::write().

circularPupil()

template<typename realT>

void mx::AO::circularPupil	(	const std::string &	pupilName,
		realT	pupilDiamPixels,
		realT	pupilDiamMeters,
		realT	centralObs = 0,
		realT	overscan = 0 )

Generate a circular pupil and saves it to disk.

Definition at line 28 of file pupil.hpp.

References mx::fits::fitsHeader< verboseT >::append(), mx::wfp::circularPupil(), and mx::fits::fitsFile< dataT, verboseT >::write().