TwiceAsNice  2019-02-18
Classes | Namespaces | Functions | Variables
CameraInfo.h File Reference
#include <string>
#include <vector>
#include <stdint.h>
#include "DefDllExport.h"
Include dependency graph for CameraInfo.h:
This graph shows which files directly or indirectly include this file:

Classes

struct  CamInfo::StrDb
 
struct  CamInfo::NetDb
 

Namespaces

 CamInfo
 Namespace the support decoding camera model names from raw input data.
 
 CamModel
 
 Apg
 

Functions

std::vector< std::string > DLL_EXPORT CamInfo::MkStrVectFromStrDb (const CamInfo::StrDb &DbStruct)
 
CamInfo::StrDb DLL_EXPORT CamInfo::MkStrDbFromStrVect (const std::vector< std::string > &strVect)
 
CamInfo::StrDb DLL_EXPORT CamInfo::GetNoOpDb ()
 
std::vector< uint8_t > DLL_EXPORT CamInfo::MkU8VectFromNetDb (const CamInfo::NetDb &DbStruct)
 
CamInfo::NetDb DLL_EXPORT CamInfo::MkNetDbFromU8Vect (const std::vector< uint8_t > &u8Vect)
 
bool DLL_EXPORT CamModel::IsAlta (uint16_t FirmwareRev)
 
bool DLL_EXPORT CamModel::IsGen2Platform (uint16_t FirmwareRev)
 
bool DLL_EXPORT CamModel::IsFirmwareRevGood (uint16_t FirmwareRev)
 
uint16_t DLL_EXPORT CamModel::MaskRawId (uint16_t FirmwareRev, uint16_t CamId)
 
CamModel::PlatformType DLL_EXPORT CamModel::GetPlatformType (uint16_t FixedId, bool IsEthernet=false)
 
CamModel::PlatformType DLL_EXPORT CamModel::GetPlatformType (const std::string &cameraLine)
 
std::string DLL_EXPORT CamModel::GetPlatformStr (uint16_t FixedId, bool IsEthernet=false)
 
std::string DLL_EXPORT CamModel::GetModelStr (uint16_t CamId)
 
std::string DLL_EXPORT CamModel::GetNoOpFirmwareRev ()
 

Variables

const uint32_t CamInfo::NET_MAGIC_VALID = 0x63626160
 
 UNKNOWN_INTERFACE
 
 USB
 
 UNKNOWN_PLATFORM
 
 ALTAU
 
 ALTAE
 
 ASCENT
 
 ASPEN
 
 HIC
 
 ALTAF
 
const uint16_t CamModel::FIRMWARE_PLATFORM_MASK = 0xFF00
 
const uint16_t CamModel::MAX_ALTA_FIRMWARE_REV = 0x0064
 
const uint16_t CamModel::MIN_GEN2_FIRMWARE = 0x0064
 
const uint16_t CamModel::MAX_GEN2_FIRMWARE = 0x0400
 
const uint16_t CamModel::ALTA_CAMERA_ID_MASK = 0x007F
 
const uint16_t CamModel::GEN2_CAMERA_ID_MASK = 0x01FF
 
const uint16_t CamModel::NO_OP_FRMWR_REV = 0x0
 
 Status_ConnectionError = -3
 
 Status_DataError = -2
 
 Status_PatternError = -1
 
 Status_Idle = 0
 
 Status_Exposing = 1
 
 Status_ImagingActive = 2
 
 Status_ImageReady = 3
 
 Status_Flushing = 4
 
 CameraMode_Normal = 0
 
 CameraMode_TDI = 1
 
 CameraMode_Test = 2
 
 CameraMode_ExternalTrigger = 3
 
 CameraMode_ExternalShutter = 4
 
 CameraMode_Kinetics = 5
 
 Resolution_SixteenBit = 0
 
 AdcSpeed_Unknown
 
 AdcSpeed_Normal
 
 AdcSpeed_Fast
 
 CoolerStatus_Off = 0
 
 CoolerStatus_RampingToSetPoint = 1
 
 CoolerStatus_AtSetPoint = 2
 
 CoolerStatus_Revision = 3
 
 FanMode_Off = 0
 
 FanMode_Low = 1
 
 FanMode_Medium = 2
 
 FanMode_High = 3
 
 LedState_Expose = 0
 
 LedState_ImageActive = 1
 
 LedState_Flushing = 2
 
 LedState_ExtTriggerWaiting = 3
 
 LedState_ExtTriggerReceived = 4
 
 LedState_ExtShutterInput = 5
 
 LedState_ExtStartReadout = 6
 
 LedState_AtTemp = 7
 
 LedMode_DisableAll = 0
 
 LedMode_DisableWhileExpose = 1
 
 LedMode_EnableAll = 2
 
 TriggerMode_Unknown
 
 TriggerMode_Normal
 
 TriggerMode_TdiKinetics
 
 TriggerMode_ExternalShutter
 
 TriggerType_Unkown
 
 TriggerType_Each
 
 ShutterState_Unkown
 
 ShutterState_Normal
 
 ShutterState_ForceOpen
 
 ErrorType_Connection = 0
 
 ErrorType_Critical = 1
 
 ErrorType_Serious = 2
 
 ErrorType_Configuration
 
 ErrorType_InvalidMode
 
 ErrorType_InvalidOperation
 
 SerialParity_Unknown = -1
 
 SerialParity_None = 0
 
 SerialParity_Odd = 1
 
 SerialFC_Unknown = -1
 
 SerialFC_Off = 0
 

Variable Documentation

◆ AdcSpeed_Fast

AdcSpeed_Fast

◆ AdcSpeed_Normal

AdcSpeed_Normal

◆ AdcSpeed_Unknown

AdcSpeed_Unknown

◆ ALTAE

ALTAE

◆ ALTAF

ALTAF

◆ ALTAU

ALTAU

◆ ASCENT

ASCENT

◆ ASPEN

ASPEN

◆ CameraMode_ExternalShutter

CameraMode_ExternalShutter = 4

While maintained for backward compatibility, this mode is deprecated and will throw an error if set. Applications should use the ExternalShutter property instead.

◆ CameraMode_ExternalTrigger

CameraMode_ExternalTrigger = 3

While maintained for backward compatibility, this mode is deprecated and will throw an error if set. Applications should use the new Apg::TriggerMode_Normal and Apg::TriggerMode_TdiKinetics properties to enable and use external hardware triggering.

◆ CameraMode_Kinetics

CameraMode_Kinetics = 5

In this mode, the user will optically mask all but a portion of the CCD. This remaining section is exposed, shifted by some number of rows, and then exposed again. The process continues until the entire CCD surface is exposed. This mode cannot be used with interline sensors.

◆ CameraMode_Normal

CameraMode_Normal = 0

Specifies nominal camera operation for exposure control. Single exposures, or sequences of exposures, are may be initiated by software or hardware control. Applications should note that the ContinuousImaging property is only available in this mode.

◆ CameraMode_TDI

CameraMode_TDI = 1

Specifies camera operation using time delayed integration (drift scan) mode. Used in conjunction with TDIRows, TDIRate and TDIBinningRows. The actual TDI exposure is started with the Expose method, but the "Duration" parameter of Expose is not used. This mode cannot be used with interline sensors.

◆ CameraMode_Test

CameraMode_Test = 2

Specifies that the camera operation should be defined using simulated data for image parameters.

◆ CoolerStatus_AtSetPoint

CoolerStatus_AtSetPoint = 2

◆ CoolerStatus_Off

CoolerStatus_Off = 0

◆ CoolerStatus_RampingToSetPoint

CoolerStatus_RampingToSetPoint = 1

◆ CoolerStatus_Revision

CoolerStatus_Revision = 3

◆ ErrorType_Configuration

ErrorType_Configuration

Error in the configuraiton data

◆ ErrorType_Connection

ErrorType_Connection = 0

Error trying to establish connection with camera

◆ ErrorType_Critical

ErrorType_Critical = 1

Critical error communicating with camera call ApogeeCam::CloseConnection() and search again for the device. If found call ApogeeCam::OpenConnection and reinitalized the camera

◆ ErrorType_InvalidMode

ErrorType_InvalidMode

Camera is not the proper mode to support the operation

◆ ErrorType_InvalidOperation

ErrorType_InvalidOperation

Operation is not support on the camera model

◆ ErrorType_Serious

ErrorType_Serious = 2

Internal error call ApogeeCam::Reset() and ApogeeCam::Init() to reset the camera

◆ FanMode_High

FanMode_High = 3

High Speed

◆ FanMode_Low

FanMode_Low = 1

Low Speed

◆ FanMode_Medium

FanMode_Medium = 2

Medium Speed

◆ FanMode_Off

FanMode_Off = 0

Turns off the fan

◆ HIC

HIC

◆ LedMode_DisableAll

LedMode_DisableAll = 0

◆ LedMode_DisableWhileExpose

LedMode_DisableWhileExpose = 1

◆ LedMode_EnableAll

LedMode_EnableAll = 2

◆ LedState_AtTemp

LedState_AtTemp = 7

◆ LedState_Expose

LedState_Expose = 0

◆ LedState_ExtShutterInput

LedState_ExtShutterInput = 5

◆ LedState_ExtStartReadout

LedState_ExtStartReadout = 6

◆ LedState_ExtTriggerReceived

LedState_ExtTriggerReceived = 4

◆ LedState_ExtTriggerWaiting

LedState_ExtTriggerWaiting = 3

◆ LedState_Flushing

LedState_Flushing = 2

◆ LedState_ImageActive

LedState_ImageActive = 1

◆ Resolution_SixteenBit

Resolution_SixteenBit = 0

◆ SerialFC_Off

SerialFC_Off = 0

The port does not/should not use flow control.

◆ SerialFC_Unknown

SerialFC_Unknown = -1

The flow control state of the port cannot be determined.

◆ SerialParity_None

SerialParity_None = 0

The port does not/should not use parity.

◆ SerialParity_Odd

SerialParity_Odd = 1

The port does/should use odd parity.

◆ SerialParity_Unknown

SerialParity_Unknown = -1

The parity state of the port cannot be determined.

◆ ShutterState_ForceOpen

ShutterState_ForceOpen

Shutter is forced open

◆ ShutterState_Normal

ShutterState_Normal

Camera performs normal shutter operations

◆ ShutterState_Unkown

ShutterState_Unkown

Error condition

◆ Status_ConnectionError

Status_ConnectionError = -3

An internal error was generated while attempting to communicate with the camera. This error may occur when a connection to the camera is attempted and failed, or if the driver detects a failure while communicating with the camera system (for example, if a USB connector is suddenly unplugged).

◆ Status_DataError

Status_DataError = -2

An internal error was generated by the camera during image readout and the internal FIFO was hung. Using the ApogeeCam::Reset() or ApogeeCam::Init() methods may return the camera to a known, good state.

◆ Status_Exposing

Status_Exposing = 1

An exposure is in progress.

◆ Status_Flushing

Status_Flushing = 4

The camera system is flushing the sensor. No other operations are in effect.

◆ Status_Idle

Status_Idle = 0

The camera system is completely idle. Flushing operations have not been started. Applications should typically never see this state after the ApogeeCam::Init() method has been called.

◆ Status_ImageReady

Status_ImageReady = 3

The camera has completed an exposure and digitized the image data. Applications should poll this flag before retrieving the image data. Once the image data has been read, the camera will return the Status_Flushing state.

◆ Status_ImagingActive

Status_ImagingActive = 2

The camera is reading out an image, or waiting for an image to begin. While an image is actually being exposed, the status returned will be Status_Exposing

◆ Status_PatternError

Status_PatternError = -1

An internalerror was generated by the camera during pixel processing. Using the ApogeeCam::Reset() or ApogeeCam::Init() methods may return the camera to a known, good state.

◆ TriggerMode_ExternalShutter

TriggerMode_ExternalShutter

◆ TriggerMode_Normal

TriggerMode_Normal

◆ TriggerMode_TdiKinetics

TriggerMode_TdiKinetics

◆ TriggerMode_Unknown

TriggerMode_Unknown

◆ TriggerType_Each

TriggerType_Each

◆ TriggerType_Unkown

TriggerType_Unkown

◆ UNKNOWN_INTERFACE

UNKNOWN_INTERFACE

◆ UNKNOWN_PLATFORM

UNKNOWN_PLATFORM

◆ USB

USB