Utilities for working with a modal basis. More...

Utilities for working with a modal basis.

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

Definition in file basis.hpp.

#include "../ioutils/fits/fitsFile.hpp"
#include "../sigproc/fourierModes.hpp"
#include "../sigproc/gramSchmidt.hpp"
#include "../improc/imageFilters.hpp"
#include "../improc/imagePads.hpp"
#include "../improc/eigenCube.hpp"
#include "../sigproc/signalWindows.hpp"
#include "../math/eigenLapack.hpp"
#include "aoPaths.hpp"

Go to the source code of this file.

Namespaces
namespace	mx
	The mxlib c++ namespace.

Macros
#define	MXAO_ORTHO_METHOD_SGS 0
	Constant to specify using the stabilized Gramm Schmidt (SGS) orthogonalization procedure.
#define	MXAO_ORTHO_METHOD_SVD 1
	Constant to specify using the singular value decomposition (SVD) for orthogonalizing a modal basis.

Functions
template<typename realT>
void	mx::AO::applyPupil2Basis (eigenCube< realT > &modes, const std::string &basisName, const std::string &pupilName, realT fwhm=0)
	Multiply a raw modal basis by a pupil mask.
template<typename realT>
void	mx::AO::orthogonalizeBasis (const std::string &orthoName, const std::string &basisName, const std::string &pupilName, int method)
	Calculate an orthogonal projection of a basis on a pupil.

Macro Definition Documentation

◆ MXAO_ORTHO_METHOD_SGS

#define MXAO_ORTHO_METHOD_SGS 0

Constant to specify using the stabilized Gramm Schmidt (SGS) orthogonalization procedure.

Definition at line 81 of file basis.hpp.

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

◆ MXAO_ORTHO_METHOD_SVD

#define MXAO_ORTHO_METHOD_SVD 1

Constant to specify using the singular value decomposition (SVD) for orthogonalizing a modal basis.

Definition at line 86 of file basis.hpp.

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

Function Documentation

◆ applyPupil2Basis()

template<typename realT>

void mx::AO::applyPupil2Basis	(	eigenCube< realT > &	modes,
		const std::string &	basisName,
		const std::string &	pupilName,
		realT	fwhm = 0 )

Multiply a raw modal basis by a pupil mask.

Definition at line 38 of file basis.hpp.

References mx::improc::filterImage(), mx::improc::padImage(), and mx::fits::fitsFile< dataT, verboseT >::read().

◆ orthogonalizeBasis()

template<typename realT>

void mx::AO::orthogonalizeBasis	(	const std::string &	orthoName,
		const std::string &	basisName,
		const std::string &	pupilName,
		int	method )

Calculate an orthogonal projection of a basis on a pupil.

Can use either the stabilized Gramm Schmidt (SGS) procedure, or Singular Value Decomposition (SVD). This calls mx::AO::applyPupil2Basis as a first step.

Parameters

[in]	basisName	the name of the basis to orthogonalize
[in]	pupilName	the name of the pupil on which to orthogonalize.
[in]	method	either MXAO_ORTHO_METHOD_SGS (for SGS) or MXAO_ORTHO_METHOD_SVD (for SVD)

Template Parameters

realT

Definition at line 143 of file basis.hpp.

References mx::fits::fitsHeader< verboseT >::append(), mx::improc::eigenCube< dataT >::image(), MXAO_ORTHO_METHOD_SGS, MXAO_ORTHO_METHOD_SVD, mx::fits::fitsFile< dataT, verboseT >::read(), and mx::fits::fitsFile< dataT, verboseT >::write().

Namespaces