mxlib
c++ tools for analyzing astronomical data and other tasks by Jared R. Males. [git repo]
Loading...
Searching...
No Matches
Enumerations | Functions
mx::improc::HCI Namespace Reference
Astronomy | Image Processing » High Contrast Imaging » HCI Enums

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 class  meanSubMethod {
  meanSubMethod::none , meanSubMethod::meanImage , meanSubMethod::medianImage , meanSubMethod::imageMean ,
  meanSubMethod::imageMedian , meanSubMethod::imageMode , meanSubMethod::unknown = -1
}
 Mean subtraction methods. More...
 
enum class  pixelTSNormMethod { none , rms , rmsSigmaClipped , unknown = -1 }
 
enum  combineMethods { noCombine , medianCombine , meanCombine , sigmaMeanCombine , debug }
 Possible combination 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.
 
int fakeMethodFmStr (const std::string &method)
 Get the fake injection method from its string name.
 
std::string combineMethodStr (int method)
 Get the string name of the combineMethod integer.
 
int combineMethodFmStr (const std::string &method)
 Get the combineMethod from the corresponding string name.
 

Enumeration Type Documentation

◆ pixelTSNormMethod

enum class mx::improc::HCI::pixelTSNormMethod
strong
Enumerator
none 

no pixel time series norm

rms 

the rms of the pixel time series

rmsSigmaClipped 

the sigma clipped rms of the pixel time series

unknown 

unknown value, an error

Definition at line 71 of file HCIobservation.hpp.

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]methodthe string name of the combineMethod

Definition at line 138 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]methodone of the combineMethods enum members

Definition at line 124 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]methodthe fake injection method name

Definition at line 34 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]methodthe fake injection method

Definition at line 18 of file ADIobservation.cpp.

References list, and single.