THORLABS DCU223 SERIES Description And Sdk Manual

© 2016 Thorlabs Scientific Imaging134
DCx Camera Functional Description and SDK Manual
hCam
Camera handle
IS_AUTO_BLACKLEVEL_ON: The automatic black level
mode is switched on.
IS_BLACKLEVEL_CMD_GET_OFFSET_DEFAULT
Returns the default offset (Example 3)
IS_BLACKLEVEL_CMD_GET_OFFSET_RANGE
Returns the range of the offset (Example 3)
IS_BLACKLEVEL_CMD_GET_OFFSET
Returns the current offset (Example 3)
IS_BLACKLEVEL_CMD_SET_OFFSET
Sets the offset (Example 3)
pParam
Pointer to a function parameter, whose function depends on nCommand.
cbSizeOfParam
Size (in bytes) of the memory area to which pParam refers.
Return values
IS_INVALID_PARAMETER
One of the submitted parameters is outside the valid range or
is not supported for this sensor or is not available in this mode.
IS_NO_SUCCESS
General error message
IS_NOT_SUPPORTED
The camera model used here does not support this function or
setting.
IS_SUCCESS
Function executed successfully
Example 1
INT nBlacklevelCaps;
nRet = is_Blacklevel(hCam, IS_BLACKLEVEL_CMD_GET_CAPS,
(void*)&nBlacklevelCaps, sizeof(nBlacklevelCaps) );
if (nRet == IS_SUCCESS) {
// The user can changed the state of the auto blacklevel
BOOL bSetAutoBlacklevel = (nBlacklevelCaps & IS_BLACKLEVEL_CAP_SET_AUTO_BLACKLEVEL) != 0;
// The user can change the offset
BOOL bSetBlacklevelOffset = (nBlacklevelCaps & IS_BLACKLEVEL_CAP_SET_OFFSET) != 0;
}
Example 2
INT nMode = IS_AUTO_BLACKLEVEL_OFF;
// Get default blacklevel mode
INT nRet = is_Blacklevel(hCam, IS_BLACKLEVEL_CMD_GET_MODE_DEFAULT, (void*)&nMode, sizeof(nMode));
// Get current blacklevel mode
nRet = is_Blacklevel(hCam, IS_BLACKLEVEL_CMD_GET_MODE, (void*)&nMode, sizeof(nMode));
// Set new mode (enable auto blacklevel)
nMode = IS_AUTO_BLACKLEVEL_ON;
nRet = is_Blacklevel(hCam, IS_BLACKLEVEL_CMD_SET_MODE, (void*)&nMode , sizeof(nMode ));
Example 3
INT nOffset = 0;
// Get default blacklevel offset
INT nRet = is_Blacklevel(hCam, IS_BLACKLEVEL_CMD_GET_OFFSET_DEFAULT,
(void*)&nOffset, sizeof(nOffset));
// Get offset range
IS_RANGE_S32 nRange;
nRet = is_Blacklevel(hCam, IS_BLACKLEVEL_CMD_GET_OFFSET_RANGE, (void*)&nRange, sizeof(nRange));
INT nOffsetMin = nRange.s32Min;
INT nOffsetMax = nRange.s32Max;
INT nOffsetInc = nRange.s32Inc;

THORLABS DCU223 SERIES Specifications

General

Brand	THORLABS
Model	DCU223 SERIES
Category	Security Camera
Language	English