Please enable JavaScript to view this site.

IDS Software Suite 4.96.1

Windows_Logo
Linux_Logo

USB 2.0

USB 3.x

GigE

USB 2.0

USB 3.x

GigE

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.

hint_info

Manually changing the pixel clock will disable the test image mode.

hint_info

This function is currently not supported by the following camera models:

UI-1007XS

Input parameters

hCam

Camera handle

TestImage

The test image to be set. See also is_GetSupportedTestImages().

Param

Additional parameter for used to modify the test image. Not available for all test images.

Return values

IS_BAD_STRUCTURE_SIZE

An internal structure has an incorrect size.

IS_CANT_COMMUNICATE_WITH_DRIVER

Communication with the driver failed because no driver has been loaded.

IS_CANT_OPEN_DEVICE

An attempt to initialize or select the camera failed (no camera connected or initialization error).

IS_CAPTURE_RUNNING

A capturing operation is in progress and must be terminated first.

IS_INVALID_BUFFER_SIZE

The image memory has an inappropriate size to store the image in the desired format.

IS_INVALID_CAMERA_TYPE

The camera type defined in the .ini file does not match the current camera model.

IS_INVALID_CAMERA_HANDLE

Invalid camera handle

IS_INVALID_MEMORY_POINTER

Invalid pointer or invalid memory ID

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_IO_REQUEST_FAILED

An IO request from the uEye driver failed. Possibly the versions of the ueye_api.dll (API) and the driver file (ueye_usb.sys or ueye_eth.sys) do not match.

IS_NO_ACTIVE_IMG_MEM

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.

IS_NO_SUCCESS

General error message

IS_NOT_CALIBRATED

The camera does not contain any calibration data.

IS_NOT_SUPPORTED

The camera model used here does not support this function or setting.

IS_NULL_POINTER

Invalid array

IS_SUCCESS

Function executed successfully

IS_TIMED_OUT

A timeout occurred. An image capturing process could not be terminated within the allowable period.

IS_TRIGGER_ACTIVATED

The function cannot be used because the camera is waiting for a trigger signal.

Related functions

is_GetSupportedTestImages()

is_GetTestImageValueRange()

© 2022 IDS Imaging Development Systems GmbH