© 2013 Thorlabs GmbH
4 Programming (SDK)
345
4.3.94 is_SetSensorTestImage
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 is_GetSupportedTestImages()
function. For some test images, the Param parameter provides additional options. If the test image does not
support additional parameters, Param will be ignored.
Attention
Manually changing the pixel clock will disable the test image mode.
Input parameters
The test image to be set. See also is_GetSupportedTestImages() .
Additional parameter for used to modify the test image. Not available for all test
images.
Return values
An internal structure has an incorrect size.
IS_CANT_COMMUNICATE_WITH_DRIVER
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.
IS_INVALID_MEMORY_POINTER
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.
The camera does not contain any calibration data.
The camera model used here does not support this
function or setting.
Function executed successfully
253
253