Is_Hotpixel - THORLABS DCU223x Operation Manual And Sdk

DCx Cameras

4.3.57 is_HotPixel

USB 2.0
USB 3.0
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
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
hCam
nCommand
IS_HOTPIXEL_DISABLE_CORRECTION
IS_HOTPIXEL_ENABLE_CAMERA_CORRECTION
IS_HOTPIXEL_ENABLE_SOFTWARE_USER_CORREC
TION
IS_HOTPIXEL_ENABLE_SENSOR_CORRECTION
IS_HOTPIXEL_DISABLE_SENSOR_CORRECTION
IS_HOTPIXEL_GET_CORRECTION_MODE
IS_HOTPIXEL_GET_SUPPORTED_CORRECTION_MO
DES
260
USB 2.0
USB 3.0
379
Basics: Hot pixels
Camera handle
Disables hot pixel correction
Enables hot pixel correction using the hot pixel list(s)
stored in the camera EEPROM.
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)
Enables sensor's own hot pixel correction function (if
available).
Disables the sensor's own hot pixel correction function.
Returns the currently set hot pixel correction mode
(Example 2 )
262
Returns the supported hot pixel correction modes.The
return value is a bitmask with the following constants
(combined by OR):
IS_HOTPIXEL_ENABLE_CAMERA_CORRECTION: Hot
pixel correction is possible via the hot pixel list in the
camera EEPROM.
.
28
(Example 1 )
262
© 2013 Thorlabs GmbH