libapogee  3.0.3234
Enumerations
Apg Namespace Reference

Enumerations

enum  Status {
  Status_ConnectionError = -3, Status_DataError = -2, Status_PatternError = -1, Status_Idle = 0,
  Status_Exposing = 1, Status_ImagingActive = 2, Status_ImageReady = 3, Status_Flushing = 4,
  Status_WaitingOnTrigger = 5
}
 
enum  CameraMode {
  CameraMode_Normal = 0, CameraMode_TDI = 1, CameraMode_Test = 2, CameraMode_ExternalTrigger = 3,
  CameraMode_ExternalShutter = 4, CameraMode_Kinetics = 5, CameraMode_Unknown = 6
}
 
enum  Resolution { Resolution_SixteenBit = 0, Resolution_TwelveBit = 1 }
 
enum  AdcSpeed { AdcSpeed_Unknown, AdcSpeed_Normal, AdcSpeed_Fast, AdcSpeed_Video }
 
enum  CoolerStatus {
  CoolerStatus_Off = 0, CoolerStatus_RampingToSetPoint = 1, CoolerStatus_AtSetPoint = 2, CoolerStatus_Revision = 3,
  CoolerStatus_Suspended = 4
}
 
enum  FanMode {
  FanMode_Off = 0, FanMode_Low = 1, FanMode_Medium = 2, FanMode_High = 3,
  FanMode_Unknown = 4
}
 
enum  LedState {
  LedState_Expose = 0, LedState_ImageActive = 1, LedState_Flushing = 2, LedState_ExtTriggerWaiting = 3,
  LedState_ExtTriggerReceived = 4, LedState_ExtShutterInput = 5, LedState_ExtStartReadout = 6, LedState_AtTemp = 7,
  LedState_Unknown = 8
}
 
enum  LedMode { LedMode_DisableAll = 0, LedMode_DisableWhileExpose = 1, LedMode_EnableAll = 2, LedMode_Unknown = 3 }
 
enum  TriggerMode {
  TriggerMode_Unknown, TriggerMode_Normal, TriggerMode_TdiKinetics, TriggerMode_ExternalShutter,
  TriggerMode_ExternalReadoutIo
}
 
enum  TriggerType { TriggerType_Unkown, TriggerType_Each, TriggerType_Group }
 
enum  ShutterState { ShutterState_Unkown, ShutterState_Normal, ShutterState_ForceOpen, ShutterState_ForceClosed }
 
enum  ErrorType {
  ErrorType_Connection = 0, ErrorType_Critical = 1, ErrorType_Serious = 2, ErrorType_Configuration,
  ErrorType_InvalidMode, ErrorType_InvalidOperation, ErrorType_InvalidUsage
}
 
enum  SerialParity { SerialParity_Unknown = -1, SerialParity_None = 0, SerialParity_Odd = 1, SerialParity_Even = 2 }
 
enum  SerialFC { SerialFC_Unknown = -1, SerialFC_Off = 0, SerialFC_On = 1 }
 

Detailed Description

Defines the different camera's statuses, modes, and type enumerations

Enumeration Type Documentation

Camera operational mode.

Enumerator
CameraMode_Normal 

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 

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 

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

CameraMode_ExternalTrigger 

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_ExternalShutter 

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

CameraMode_Kinetics 

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_Unknown 

Error mode. Application should set the camera mode to CameraMode_Normal and call the Reset() or Init() methods to return the camera to a known, good state.

Exception Error Catagories. See the Exception Handling page for more information

Enumerator
ErrorType_Connection 

Error trying to establish connection with camera

ErrorType_Critical 

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

ErrorType_Serious 

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

ErrorType_Configuration 

Error in the configuraiton data

ErrorType_InvalidMode 

Camera is not the proper mode to support the operation

ErrorType_InvalidOperation 

Operation is not support on the camera model

ErrorType_InvalidUsage 

Invalid information was given to function

Camera Fan Mode

Enumerator
FanMode_Off 

Turns off the fan

FanMode_Low 

Low Speed

FanMode_Medium 

Medium Speed

FanMode_High 

High Speed

FanMode_Unknown 

Error state.

AltaU serial port flow control type

Enumerator
SerialFC_Unknown 

The flow control state of the port cannot be determined.

SerialFC_Off 

The port does not/should not use flow control.

SerialFC_On 

The port does/should use flow control.

AltaU serial port parity type

Enumerator
SerialParity_Unknown 

The parity state of the port cannot be determined.

SerialParity_None 

The port does not/should not use parity.

SerialParity_Odd 

The port does/should use odd parity.

SerialParity_Even 

The port does/should use even parity

Camera's shutter state

Enumerator
ShutterState_Unkown 

Error condition

ShutterState_Normal 

Camera performs normal shutter operations

ShutterState_ForceOpen 

Shutter is forced open

ShutterState_ForceClosed 

Shutter is forced closed and disabled during an exposure

The current imaging state of the camera.

Enumerator
Status_ConnectionError 

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 

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_PatternError 

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.

Status_Idle 

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_Exposing 

An exposure is in progress.

Status_ImagingActive 

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_ImageReady 

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_Flushing 

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

Status_WaitingOnTrigger 

The camera is waiting for a trigger event to start an exposure.