mx::improc::HCI Namespace Reference

Namespace for high contrast imaging enums. More...

Namespace for high contrast imaging enums.

Enumerations
enum	fakeMethods { single , list }
	Fake injection PSF file specification methods. More...
enum	combineMethods { noCombine , medianCombine , meanCombine , sigmaMeanCombine , debug }
	Possible combination methods. More...
enum	meansubMethods {   imageMean , imageMedian , imageMode , meanImage ,   medianImage }
	Mean subtraction methods. More...
enum	excludeMethods { excludeNone , excludePixel , excludeAngle , excludeImno }
	Image exclusion methods. More...
enum	includeMethods {   includeAll , includeCorr , includeTime , includeAngle ,   includeImno }
	Image inclusion methods. More...

Functions
std::string	fakeMethodsStr (int method)
	Get the string name of a fake injection method. More...
int	fakeMethodFmStr (const std::string &method)
	Get the fake injection method from its string name. More...
std::string	combineMethodStr (int method)
	Get the string name of the combineMethod integer. More...
int	combineMethodFmStr (const std::string &method)
	Get the combineMethod from the corresponding string name. More...

Function Documentation

combineMethodFmStr()

int mx::improc::HCI::combineMethodFmStr

(

const std::string &

method

)

Get the combineMethod from the corresponding string name.

Returns

the combineMethods enum member corresponding to the string name.

Parameters

[in]

method

the string name of the combineMethod

Definition at line 28 of file HCIobservation.cpp.

References meanCombine, medianCombine, noCombine, and sigmaMeanCombine.

Referenced by mx::improc::HCIobservation< _realT >::readPSFSub().

combineMethodStr()

std::string mx::improc::HCI::combineMethodStr

(

int

method

)

Get the string name of the combineMethod integer.

Returns

a string with the name of the combineMethod

Parameters

[in]

method

one of the combineMethods enum members

Definition at line 19 of file HCIobservation.cpp.

References meanCombine, medianCombine, noCombine, and sigmaMeanCombine.

Referenced by mx::improc::HCIobservation< _realT >::stdFitsHeader(), and mx::improc::HCIobservation< _realT >::writeFinim().

fakeMethodFmStr()

int mx::improc::HCI::fakeMethodFmStr

(

const std::string &

method

)

Get the fake injection method from its string name.

Returns

the corresponding member of the fakeMethods enum

Parameters

[in]

method

the fake injection method name

Definition at line 27 of file ADIobservation.cpp.

References list, and single.

fakeMethodsStr()

std::string mx::improc::HCI::fakeMethodsStr

(

int

method

)

Get the string name of a fake injection method.

Returns

the string name corresponding to the fake injection method

Parameters

[in]

method

the fake injection method

Definition at line 20 of file ADIobservation.cpp.

References list, and single.