Teledyne Princeton Instruments PICam 5.x, Programmer'S Manual

Page: 301 / 357

Chapter 8 EM Calibration APIs 301
8.4.4 EM Calibration APIs
This section provides programming information about EM Calibration APIs.
8.4.4.1
PicamEMCalibration_Calibrate()
Description
PicamEMCalibration_Calibrate()
calibrates the EM Gain for a specified camera.
NOTE:
Calibration cannot begin until the status of the current
sensor temperature is locked.
NOTE:
If calibration is canceled (via the use of the callback function
PicamEMCalibrationCallback() ) this function returns
PicamError_OperationCanceled
.
Syntax
The syntax for PicamEMCalibration_Calibrate() is:
PICAM_API PicamEMCalibration_Calibrate(
PicamHandle calibration,
PicamEMCalibrationCallback calllback,
void* user_state);
Input Parameters
Input parameters for PicamEMCalibration_Calibrate() are:
Output Parameters
There are no output parameters associated with
PicamEMCalibration_Calibrate() .
Related APIs
For additional information, refer to the following related APIs:
• PicamEMCalibration_ReadSensorTemperatureStatus() ;
• PicamEMCalibrationCallback() .
calibration:
Handle for the camera for which EM calibration is to be performed.
callback:
Optional Callback function.
Specifying a Callback provides additional functionality, such as:
• The ability to cancel a calibration process;
• The ability to obtain calibration progress information.
user_state:
[optional]
When used, allows the caller to provide user-defined data to the
callback function.