Is_Setsensortestimage - THORLABS DCU223x Operation Manual And Sdk

4.3.94 is_SetSensorTestImage

USB 2.0
USB 3.0
Syntax
INT is_SetSensorTestImage (HIDS hCam, INT TestImage, INT Param)
Description
is_SetSensorTestImage() enables a test image function in the sensor. You can select different test images.
The test images supported by a particular camera can be queried using the
function. For some test images, the Param parameter provides additional options. If the test image does not
253
support additional parameters, Param will be ignored.
Attention
Manually changing the pixel clock will disable the test image mode.
Input parameters
hCam
TestImage
Param
Return values
IS_BAD_STRUCTURE_SIZE
IS_CANT_COMMUNICATE_WITH_DRIVER
IS_CANT_OPEN_DEVICE
IS_CAPTURE_RUNNING
IS_INVALID_BUFFER_SIZE
IS_INVALID_CAMERA_TYPE
IS_INVALID_CAMERA_HANDLE
IS_INVALID_MEMORY_POINTER
IS_INVALID_PARAMETER
IS_IO_REQUEST_FAILED
IS_NO_ACTIVE_IMG_MEM
IS_NO_SUCCESS
IS_NOT_CALIBRATED
IS_NOT_SUPPORTED
IS_NULL_POINTER
IS_SUCCESS
© 2013 Thorlabs GmbH
USB 2.0
USB 3.0
Camera handle
The test image to be set. See also
Additional parameter for used to modify the test image. Not available for all test
images.
An internal structure has an incorrect size.
Communication with the driver failed because no driver
has been loaded.
An attempt to initialize or select the camera failed (no
camera connected or initialization error).
A capturing operation is in progress and must be
terminated before you can start another one.
The image memory has an inappropriate size to store
the image in the desired format.
The camera type defined in the .ini file does not match
the current camera model.
Invalid camera handle
Invalid pointer or invalid memory ID
One of the submitted parameters is outside the valid
range or is not supported for this sensor or is not
available in this mode.
An IO request from the uc480 driver failed. Possibly the
versions of the uc480_api.dll (API) and the driver file
(uc480_usb.sys) do not match.
No active image memory available. You must set the
memory to active using the is_SetImageMem()
function or create a sequence using the
is_AddToSequence() function.
General error message
The camera does not contain any calibration data.
The camera model used here does not support this
function or setting.
Invalid array
Function executed successfully
4 Programming (SDK)
is_GetSupportedTestImages()
is_GetSupportedTestImages()
.
253
345