is_ForceTrigger

uEye Camera Manual Version 4.92


is_ForceTrigger

Windows_Logo
Linux_Logo

USB 2.0

USB 3.0

GigE

USB 2.0

USB 3.0

GigE

Syntax

INT is_ForceTrigger (HIDS hCam)

Description

You can use is_ForceTrigger() to force a software-controlled capture of an image while a capturing process triggered by hardware is in progress. This function can only be used if the triggered capturing process was started using the IS_DONT_WAIT parameter.

hint_info

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

•UI-3013XC

•UI-1007XS

To determine not processed trigger signals, use the is_CameraStatus() function with the IS_TRIGGER_MISSED parameter. For this, the following order is recommended:

1.Call the is_CameraStatus() function with the IS_TRIGGER_MISSED parameter to set the error counter to "0" at the beginning.

2.Call the is_ForceTrigger() function.

3.Call the is_CameraStatus() function with the IS_TRIGGER_MISSED parameter again to query the number of not processed trigger signals.

4.If IS_TRIGGER_MISSED = 0, the trigger signal was successfully processed. If IS_TRIGGER_MISSED > 0, the trigger signal could not be processed at this time. In this case, you have to trigger a trigger signal again via the is_ForceTrigger() function.

5.In any case, you should additionally analyze the return value of the is_ForceTrigger() function.

Input parameters

hCam

Camera handle

Return values

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_INVALID_CAMERA_HANDLE

Invalid camera handle

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_SUCCESS

General error message

IS_SUCCESS

Function executed successfully

Related functions

•is_FreezeVideo()

•is_CaptureVideo()

•is_SetExternalTrigger()

Example

Enable trigger and wait 1 second for the external trigger. If no trigger signal has arrived, force an exception using is_ForceTrigger().

#ifndef __linux__
HANDLE hEvent = CreateEvent(NULL, TRUE, FALSE, "");
 if (hEvent != NULL)

 {
#else

 HANDLE hEvent;

#endif

 
is_InitEvent(hCam, hEvent, IS_SET_EVENT_FRAME);
is_EnableEvent(hCam, IS_SET_EVENT_FRAME);
 
is_SetExternalTrigger(hCam, IS_SET_TRIGGER_HI_LO);
is_FreezeVideo(hCam, IS_DONT_WAIT);
 
#ifndef __linux__
 if (WaitForSingleObject(hEvent, 1000) != WAIT_OBJECT_0)
#else
 if (is_WaitEvent(hCam, IS_SET_EVENT_FRAME, 1000))
#endif
 {
   // No trigger has been received, so force image capture
  is_ForceTrigger(hCam);
 }
 
is_DisableEvent(hCam, IS_SET_EVENT_FRAME);
is_ExitEvent(hCam, IS_SET_EVENT_FRAME);
#ifndef __linux__
}
#endif

Suggestion for improvement? Send us your short Feedback on this chapter. Thank you very much!
For technical questions please contact your local distributor or use the support form on our website.


© 2019 IDS Imaging Development Systems GmbH
https://en.ids-imaging.com