© 2016 Thorlabs Scientific Imaging260
DCx Camera Functional Description and SDK Manual
4.3.58 is_HotPixel
Syntax
INT is_HotPixel (HIDS hCam, UINT nCommand, void* pParam, UINT nSizeOfParam)
Description
is_HotPixel() configures the correction of sensor hot pixels. The correction is performed by the
software. The hot pixel list is stored in the camera's non-volatile EEPROM. Some sensor models
can also correct hot pixels directly in the sensor.
For further information on hot pixel correction, please refer to Basics: Hot pixels.
The nCommand input parameter is used to select the function mode. The pParam input parameter
depends on the selected function mode. If you select functions for setting or returning a value,
pParam contains a pointer to a variable of the UINT type. The size of the memory area to which
pParam refers is specified in the nSizeOfParam input parameter.
Attention
This correction will not work with subsampling or with binning factors greater than 2.
Note
Previous hot pixel functions
The is_HotPixel() function comprises all hot pixel correction functions. The following uc480 API
commands are therefore obsolete:
is_SetBadPixelCorrection()
is_SetBadPixelCorrectionTable()
is_LoadBadPixelCorrectionTable()
is_SaveBadPixelCorrectionTable()
See also Obsolete functions
Input parameters
IS_HOTPIXEL_DISABLE_CORRECTION
Disables hot pixel correction (Example 1)
IS_HOTPIXEL_ENABLE_CAMERA_CORRECTION
Enables hot pixel correction using the hot pixel
list(s) stored in the camera EEPROM.
IS_HOTPIXEL_ENABLE_SOFTWARE_USER_CORREC
TION
Enables hot pixel correction using the user's hot
pixel list stored in the computer. This requires the
user's hot pixel list to be set
(IS_HOTPIXEL_SET_SOFTWARE_USER_LIST)
IS_HOTPIXEL_ENABLE_SENSOR_CORRECTION
Enables sensor's own hot pixel correction function
(if available).
IS_HOTPIXEL_DISABLE_SENSOR_CORRECTION
Disables the sensor's own hot pixel correction
function.