![]() |
VR-Vantage 3.1 API Documentation
|
Public Member Functions | |
| double | getDwellTime () |
| void | setDwellTime (double dwellTime) |
| double | getNET () |
| void | setNET (double NET) |
| double | getFixedPatternNoisePercent () |
| void | setFixedPatternNoisePercent (double percentNoise) |
| double | getNER () |
| void | setNER (double NER) |
| double | getNoiseFreqKnee () |
| void | setNoiseFreqKnee (double noiseFreqKnee) |
| double | getNoiseFreqExp () |
| void | setNoiseFreqExp (double noiseFreqExp) |
| double | getResolutionScale () |
| void | setResolutionScale (double resolutionScale) |
| double | getPitchDetH () |
| void | setPitchDetH (double pitchDetH) |
| double | getPitchDetV () |
| void | setPitchDetV (double pitchDetV) |
| double | getJitterAmplitudeH () const |
| void | setJitterAmplitudeH (double jitterAmpH) |
| double | getJitterAmplitudeV () const |
| void | setJitterAmplitudeV (double jitterAmpV) |
| double | getJitterFrequencyH () const |
| void | setJitterFrequencyH (double jitterFreqH) |
| double | getJitterFrequencyV () const |
| void | setJitterFrequencyV (double jitterFreqV) |
| double | getBackTemp () |
| void | setBackTemp (double backTemp) |
| double | getPercentPixelFill () |
| void | setPercentPixelFill (double pixelFill) |
| double | getPercentDeadPixel () |
| void | setPercentDeadPixel (double deadPixel) |
| long | getNumDetStaresH () |
| returns the number of detectors in the horizontal direction | |
| void | setNumDetStaresH (long numDetStaresH) |
| sets the number of detectors in the horizontal direction | |
| long | getNumDetStaresV () |
| void | setNumDetStaresV (long numDetStaresV) |
| double | getStartWavelength () |
| void | setStartWavelength (double startWavelength) |
| double | getEndWavelength () |
| void | setEndWavelength (double endWavelength) |
| void | setPoissonNoisePercent (double percent) |
| double | getPoissonNoisePercent () |
| void | setFInverseNoisePercent (double percent) |
| double | getFInverseNoisePercent () |
| void | setSensorIndex (int sensorIndex) |
| int | getSensorIndex () |
| void | setScanMaskMinGain (float minGain) |
| float | getScanMaskMinGain () |
| void | setScanMaskMaxGain (float maxGain) |
| float | getScanMaskMaxGain () |
| void | setScanMaskMinLevel (float minLevel) |
| float | getScanMaskMinLevel () |
| void | setScanMaskMaxLevel (float maxLevel) |
| float | getScanMaskMaxLevel () |
| void | setScanMaskLineSpacing (int lineSpacing) |
| int | getScanMaskLineSpacing () |
| void | setNonUniformityEnable (bool enable) |
| bool | getNonUniformityEnable () |
| void | setScanMaskGainFilename (char *gainFilename) |
| char * | getScanMaskGainFilename () |
| void | setScanMaskLevelFilename (char *levelFilename) |
| char * | getScanMaskLevelFilename () |
| void | setScanMaskDirection (int direction) |
| int | getScanMaskDirection () |
| void | setScanMaskUserDefined (bool userDefined) |
| bool | getScanMaskUserDefined () |
| void | setFullColorEnable (bool enable) |
| bool | getFullColorEnable () |
| void | setChargeWellCapacity (double threshold) |
| double | getChargeWellCapacity () const |
| void | setQuantumEfficiency (double efficiency) |
| double | getQuantumEfficiency () const |
| void | setAntiBloomingType (int antibloomDirection) |
| int | getAntiBloomingType () const |
| void | setMaterialWavelengthCutOnCutOff (double cuton, double cutoff) |
| void | getMaterialWavelengthCutOnCutOff (double &cuton, double &cutoff) const |
| void | setMicroChannelPlateDistance (double distance) |
| double | getMicroChannelPlateDistance () const |
| void | setPhotoCathodeVoltage (double voltage) |
| double | getPhotoCathodeVoltage () const |
| double | getWellCapacityPercentage () const |
| gets the percentage of the well capacity for a desired gain | |
| void | setWellCapacityPercentage (double percentage) |
| sets the percentage of the well capacity for a desired gain | |
| double | getReadoutNoiseNumElectron () const |
| gets the number of electrons for the readout noise | |
| void | setReadoutNoiseNumElectron (double electrons) |
| gets the number of electrons for the readout noise | |
| bool | get3DNoiseEnable () const |
| gets the state on whether 3D noise is enabled or not | |
| void | set3DNoiseEnable (bool enable) |
| sets the state on whether 3D noise is enabled or not | |
| float | get3DNoiseSigmaH () const |
| gets the horizontal STD for 3D noise | |
| void | set3DNoiseSigmaH (float STD) |
| sets the horizontal STD for 3D noise | |
| float | get3DNoiseSigmaV () const |
| gets the vertical STD for 3D noise | |
| void | set3DNoiseSigmaV (float STD) |
| sets the vertical STD for 3D noise | |
| float | get3DNoiseSigmaVH () const |
| gets the horizontal vertical STD for 3D noise | |
| void | set3DNoiseSigmaVH (float STD) |
| sets the horizontal vertical STD for 3D noise | |
| float | get3DNoiseSigmaT () const |
| gets the temporal STD for 3D noise | |
| void | set3DNoiseSigmaT (float STD) |
| sets the temporal STD for 3D noise | |
| float | get3DNoiseSigmaTH () const |
| gets the temporal horizontal STD for 3D noise | |
| void | set3DNoiseSigmaTH (float STD) |
| sets the temporal horizontal STD for 3D noise | |
| float | get3DNoiseSigmaTV () const |
| gets the temporal vertical STD for 3D noise | |
| void | set3DNoiseSigmaTV (float STD) |
| sets the temporal vertical STD for 3D noise | |
| float | get3DNoiseSigmaTVH () const |
| gets the temporal vertical horizontal STD for 3D noise | |
| void | set3DNoiseSigmaTVH (float STD) |
| sets the temporal vertical horizontal STD for 3D noise | |
| bool | archive (std::ofstream &outf, int idx=0) |
| int | serialize (char *filepath, int idx) |
| bool | loadXML (clXMLNode *xmlParentNode) |
| bool | parseXML (clXML &xmlDocument) |
| bool | loadXMLNode (std::string tag, char *nodeString) |
| bool | loadXMLNode (std::string tag, bool *nodeBool) |
| bool | loadXMLNode (std::string tag, int *nodeInt) |
| bool | loadXMLNode (std::string tag, long *nodeLong) |
| bool | loadXMLNode (std::string tag, double *nodeDouble) |
| void | saveXML (clXML *xmlDocument) |
| int | serializeCheck (char *filepath) |
| Checks the saved configuration file for whether it has more than one panel saved. | |
| ciDetector | operator= (ciDetector &obj) |
| ciDetector () | |
| ciDetector (ciDetector &obj) | |
| virtual | ~ciDetector () |
Protected Attributes | |
| double | m_startWavelength |
| double | m_endWavelength |
| double | m_dwellTime |
| double | m_NET |
| double | m_FixedNoisePercent |
| double | m_noiseFreqExp |
| double | m_noiseFreqKnee |
| long | m_numDetStaresH |
| long | m_numDetStaresV |
| double | m_pitchDetH |
| double | m_pitchDetV |
| double | m_jitterAmpH |
| double | m_jitterAmpV |
| double | m_jitterFreqH |
| double | m_jitterFreqV |
| double | m_backTemp |
| double | m_NER |
| double | m_percentPixelFill |
| double | m_percentDeadPixel |
| double | m_resolutionScale |
| double | m_percentPoisson |
| double | m_percentFInverse |
| bool | m_nonUniformityEnable |
| char | m_scanMaskGainFilename [512] |
| char | m_scanMaskLevelFilename [512] |
| int | m_scanMaskDirection |
| float | m_scanMaskMinGain |
| float | m_scanMaskMaxGain |
| float | m_scanMaskMinLevel |
| float | m_scanMaskMaxLevel |
| int | m_scanMaskLineSpacing |
| bool | m_scanMaskUserDefined |
| double | m_chargeWellCapacity |
| charge well count for each detector pixel | |
| double | m_quantumEfficiency |
| efficiency of the well converting photons to electrons for processing | |
| int | m_antiBloomDirection |
| anti bloom directionality | |
| double | m_wavelengthCutOn |
| cuton wavelength for the material | |
| double | m_wavelengthCutOff |
| cutoff wavelength for the material | |
| double | m_microChannelPlateDistance |
| distance between the MCP and the PC (photocathode) for PMT type detectors | |
| double | m_photoCathodeVoltage |
| voltage from photocathode to the micro channel plate | |
| float | m_electronReadoutNoise |
| float | m_wellCapacityPercentage |
| bool | m_enable3DNoise |
| enable 3D noise feature | |
| float | m_3DNoiseSigmaH |
| horizontal STD for 3D noise | |
| float | m_3DNoiseSigmaV |
| horizontal STD for 3D noise | |
| float | m_3DNoiseSigmaVH |
| horizontal and vertical STD for 3D noise | |
| float | m_3DNoiseSigmaT |
| temporal STD for 3D noise | |
| float | m_3DNoiseSigmaTH |
| temporal horizontal STD for 3D noise | |
| float | m_3DNoiseSigmaTV |
| temporal vertical STD for 3D noise | |
| float | m_3DNoiseSigmaTVH |
| temporal vertical horizontal STD for 3D noise | |
| bool | m_fullColorEnable |
| int | m_sensorIndex |
| clXMLNode * | m_parentNode |
ciDetector class declaration
| ciDetector::ciDetector | ( | ) |
| ciDetector::ciDetector | ( | ciDetector & | obj | ) |
| obj | - ciDetector object to be copied. |
|
virtual |
|
inline |
|
inline |
| DwellTime | - The dwell time. |
|
inline |
|
inline |
| NET | (noise equivalent Temperature). |
|
inline |
|
inline |
| percentNEDT | (percent noise equivalent delta temperature). |
|
inline |
|
inline |
|
inline |
|
inline |
| noiseFreqKnee | - The Noise Frequency Knee to be assigned. |
|
inline |
|
inline |
| noiseFreqExp | - The Noise Frequency exponent to be assigned. |
|
inline |
|
inline |
| numDetStaresV | - The number of Detector stares vertical to be assigned. |
|
inline |
|
inline |
| pitchDetH | - The horizontal detector pitch to be assigned. |
|
inline |
|
inline |
| pitchDetV | - The vertical detector pitch to be assigned. |
|
inline |
|
inline |
| jitterAmpH | - The horizontal jitter amplitude to be assigned. |
|
inline |
|
inline |
| jitterAmpH | - The vertical jitter amplitude to be assigned. |
|
inline |
|
inline |
| jitterAmpH | - The horizontal jitter frequency to be assigned. |
|
inline |
|
inline |
| jitterAmpH | - The vertical jitter frequency to be assigned. |
|
inline |
|
inline |
| backTemp | - The background temperature [deg K] to be assigned. |
|
inline |
|
inline |
| pixelFill | - The percent pixel fill to be assigned. |
|
inline |
|
inline |
| deadPixel | - The percent dead pixel to be assigned. |
|
inline |
returns the number of detectors in the horizontal direction
|
inline |
sets the number of detectors in the horizontal direction
| long | numDetStaresH - number of horizontal dectectors to be used |
|
inline |
|
inline |
| numDetStaresV | - The number of Detector stares vertical to be assigned. |
|
inline |
|
inline |
| startWavelength | - The starting wavelength to be assigned. |
|
inline |
|
inline |
| endWavelength | - The ending wavelength to be assigned. |
|
inline |
| double | percent |
|
inline |
|
inline |
| double | percent |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
| void ciDetector::setScanMaskGainFilename | ( | char * | gainFilename | ) |
|
inline |
| void ciDetector::setScanMaskLevelFilename | ( | char * | levelFilename | ) |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
|
inline |
gets the percentage of the well capacity for a desired gain
|
inline |
sets the percentage of the well capacity for a desired gain
| percentage |
|
inline |
gets the number of electrons for the readout noise
|
inline |
gets the number of electrons for the readout noise
| electrons |
|
inline |
gets the state on whether 3D noise is enabled or not
sets the state on whether 3D noise is enabled or not
| enable |
|
inline |
gets the horizontal STD for 3D noise
|
inline |
sets the horizontal STD for 3D noise
| horizontal | STD |
|
inline |
gets the vertical STD for 3D noise
|
inline |
sets the vertical STD for 3D noise
| vertical | STD |
|
inline |
gets the horizontal vertical STD for 3D noise
|
inline |
sets the horizontal vertical STD for 3D noise
| horizontal | vertical STD |
|
inline |
gets the temporal STD for 3D noise
|
inline |
sets the temporal STD for 3D noise
| temporal | STD |
|
inline |
gets the temporal horizontal STD for 3D noise
|
inline |
sets the temporal horizontal STD for 3D noise
| temporal | horizontal STD |
|
inline |
gets the temporal vertical STD for 3D noise
|
inline |
sets the temporal vertical STD for 3D noise
| temporal | vertical STD |
|
inline |
gets the temporal vertical horizontal STD for 3D noise
|
inline |
sets the temporal vertical horizontal STD for 3D noise
| temporal | vertical horizontal STD |
| filepath | - complete path and filename to the file |
| filepath | - complete path and filename to the file |
| bool ciDetector::loadXMLNode | ( | std::string | tag, |
| char * | nodeString | ||
| ) |
| std::string | tag |
| char | *nodeString |
| bool ciDetector::loadXMLNode | ( | std::string | tag, |
| bool * | nodeBool | ||
| ) |
| std::string | tag |
| bool | *nodeBool |
| bool ciDetector::loadXMLNode | ( | std::string | tag, |
| int * | nodeInt | ||
| ) |
| std::string | tag |
| int | *nodeInt |
| bool ciDetector::loadXMLNode | ( | std::string | tag, |
| long * | nodeLong | ||
| ) |
| std::string | tag |
| long | *nodeLong |
| bool ciDetector::loadXMLNode | ( | std::string | tag, |
| double * | nodeDouble | ||
| ) |
| std::string | tag |
| double | *nodeDouble |
| int ciDetector::serializeCheck | ( | char * | filepath | ) |
Checks the saved configuration file for whether it has more than one panel saved.
| char | *filepath - path of the configuration file that is being checked. |
| ciDetector ciDetector::operator= | ( | ciDetector & | obj | ) |
|
protected |
starting wavelength [microns]
|
protected |
ending wavelength [microns]
|
protected |
dwell time
|
protected |
Noise Equivalent Temperature [deg K].
|
protected |
Percent Fixed Pattern Noise [NEDT]
|
protected |
Noise Frequency Exponent
|
protected |
Noise Frequency Knee
|
protected |
Num Det Stares Horizontal
|
protected |
Num Det Stares Vertical
|
protected |
Detector pitch Horizontal
|
protected |
Detector pitch Vertical
|
protected |
Jitter amplitude in the horizontal direction
|
protected |
Jitter amplitude in the vertical direction
|
protected |
Jitter frequency in the horizontal direction
|
protected |
Jitter frequency in the vertical direction
|
protected |
Background Temperature [deg K]
|
protected |
Noise Equivalent Radiance
|
protected |
Percent Pixel Fill
|
protected |
Percent dead Pixel
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
|
protected |
charge well count for each detector pixel
|
protected |
efficiency of the well converting photons to electrons for processing
|
protected |
anti bloom directionality
|
protected |
cuton wavelength for the material
|
protected |
cutoff wavelength for the material
|
protected |
distance between the MCP and the PC (photocathode) for PMT type detectors
|
protected |
voltage from photocathode to the micro channel plate
|
protected |
|
protected |
|
protected |
enable 3D noise feature
|
protected |
horizontal STD for 3D noise
|
protected |
horizontal STD for 3D noise
|
protected |
horizontal and vertical STD for 3D noise
|
protected |
temporal STD for 3D noise
|
protected |
temporal horizontal STD for 3D noise
|
protected |
temporal vertical STD for 3D noise
|
protected |
temporal vertical horizontal STD for 3D noise
|
protected |
|
protected |
|
protected |