IDS Software Suite 4.96.1
 |
 |
|---|---|
USB 3 uEye CP Rev. 2 uEye SE USB 3.1 Gen 1 |
USB 3 uEye CP Rev. 2 uEye SE USB 3.1 Gen 1 |
Syntax
INT is_Sequencer(HIDS hCam, UINT nCommand, void* pParam, UINT cbSizeOfParams)
Description
Using is_Sequencer(), you configure and activate the sequencer mode. In sequencer mode, you can define different parameters for image acquisition via sequencer sets that are processed one after another. For example, you can create imaging sequences with different exposure times. Therefore, fast parameter changes are possible.
Each sequencer set has the following settings:
•Exposure time
•Gain (master, red, green and blue)
•X and Y position of the area of interest (AOI)
•Flash settings
•Reference to the following sequencer set using a sequencer path
The sequencer sets are edited and saved in configuration mode.
Conditions for the use of the sequencer mode
•The sequencer mode is supported in trigger mode only.
•The sequencer mode must be activated before the image acquisition starts.
•The internal image memory must be activated.
•The following functions cannot be used in combination with the sequencer mode: multi AOI function, sequence AOI mode, and IDS line scan (AOI merge mode).
|
The sequencer mode is not supported by the UI-359xCP Rev.2 camera model. |
The nCommand input parameter is used to select the function mode. The pParam input parameter depends on the selected function mode. If you select functions for setting or returning a value, pParam contains a pointer to a variable of the UINT type. The size of the memory area to which pParam refers is specified in the cbSizeOfParam input parameter.
Input parameters
hCam |
Camera handle |
pParam |
Pointer to a function parameter, whose function depends on nCommand. |
cbSizeOfParam |
Size (in bytes) of the memory area to which pParam refers. |
Contents of the IS_SEQUENCER_PATH structure
UINT |
u32PathIndex |
Configuration path Possible values: 0 or 1 |
|---|---|---|
UINT |
u32NextIndex |
Defines the next sequencer set. •Value range: 0…31 |
UINT |
u32TriggerSource |
Defines the trigger source: •IS_TRIGGER_SOURCE_EXPOSURE_END: Triggers the next sequencer set with end of exposure. •IS_TRIGGER_SOURCE_FRAME_END: Triggers the next sequencer set with the end of image readout. •IS_TRIGGER_SOURCE_FRAME_START: Triggers the next sequencer set with the beginn of image readout. •IS_TRIGGER_SOURCE_OFF: Disables the sequencer trigger source, which means that no further set is started after this sequencer set. The supported trigger sources can be queried with IS_SEQUENCER_TRIGGER_SOURCE_SUPPORTED_GET. |
UINT |
u32TriggerActivation |
Defines the activation mode. Possible value: 0 |
Contents of the IS_SEQUENCER_GAIN_CONFIGURATION structure
UINT |
Master |
Sets the master gain factor (0...100) |
UINT |
Red |
Sets the red channel gain factor (0...100). |
UINT |
Green |
Sets the green channel gain factor (0...100). |
UINT |
Blue |
Sets the blue channel gain factor (0...100) |
Contents of the IS_SEQUENCER_FLASH_CONFIGURATION structure
UINT |
u32Mode |
Flash mode, see Using flash |
UINT |
u32Duration |
Flash duration (in μs) If 0 is passed, the flash output will be active until the end of the exposure time. For sensors with Global Start Shutter this is the time until the end of exposure of the first sensor row. |
UINT |
u32Delay |
Flash delay (in μs) |
Return values
IS_CAPTURE_RUNNING |
A capturing operation is in progress and must be terminated first. |
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_NOT_SUPPORTED |
The camera model used here does not support this function or setting. |
IS_SUCCESS |
Function executed successfully |
Related functions
/* Enable sequencer configuration */
int enableConfiguration = 1;
nRet = is_Sequencer(hCam, IS_SEQUENCER_CONFIGURATION_ENABLED_SET, &enableConfiguration, sizeof(enableConfiguration));
/* Select feature and enable it */
/* Select feature */
int64_t feature = IS_FEATURE_EXPOSURE;
nRet = is_Sequencer(hCam, IS_SEQUENCER_FEATURE_SELECTED_SET, &feature, sizeof(feature));
/* Enable feature */
int enableFeature = 1;
nRet = is_Sequencer(hCam, IS_SEQUENCER_FEATURE_ENABLED_SET, &enableFeature, sizeof(enableFeature));
/* Select the set */
selectedSet = 0;
nRet = is_Sequencer(hCam, IS_SEQUENCER_SET_SELECTED_SET, &selectedSet, sizeof(selectedSet));
/* Set exposure value */
nRet = is_Exposure(hCam, IS_EXPOSURE_CMD_SET_EXPOSURE, &exposureValue, sizeof(exposureValue));
/* Set path configuration */
IS_SEQUENCER_PATH path = { 0, 1, IS_TRIGGER_SOURCE_FRAME_END, 0 };
nRet = is_Sequencer(hCam, IS_SEQUENCER_SET_PATH_SET, &path, sizeof(path));
/* Save configuration for the selected set */
nRet = is_Sequencer(hCam, IS_SEQUENCER_SET_SAVE, 0, 0);
/* Disable configuration mode */
enableConfiguration = 0;
nRet = is_Sequencer(hCam, IS_SEQUENCER_CONFIGURATION_ENABLED_SET, &enableConfiguration, sizeof(enableConfiguration));
/* Enable sequencer mode */
int enableSequencer = 1;
nRet = is_Sequencer(hCam, IS_SEQUENCER_MODE_ENABLED_SET, &enableSequencer, sizeof(enableSequencer));
/* Flash value example */
/* Select flash feature */
int64_t feature = IS_FEATURE_FLASH;
nRet = is_Sequencer(cam.hCam, IS_SEQUENCER_FEATURE_SELECTED_SET, &feature, sizeof(feature));
/* Get flash configuration */
IS_SEQUENCER_FLASH_CONFIGURATION flashConfiguration;
nRet = is_Sequencer(cam.hCam, IS_SEQUENCER_FEATURE_VALUE_GET, &flashConfiguration, sizeof(flashConfiguration));
INT nSupportedTriggerSource = 0;
int nRet = is_Sequencer(hCam, IS_SEQUENCER_TRIGGER_SOURCE_SUPPORTED_GET, &nSupportedTriggerSource, sizeof(nSupportedTriggerSource));
if ((nSupportedTriggerSource & IS_TRIGGER_SOURCE_FRAME_END) == IS_TRIGGER_SOURCE_FRAME_END)
{
// Trigger source 'IS_TRIGGER_SOURCE_FRAME_END' is supported
}
if ((nSupportedTriggerSource & IS_TRIGGER_SOURCE_EXPOSURE_END) == IS_TRIGGER_SOURCE_EXPOSURE_END)
{
// Trigger source 'IS_TRIGGER_SOURCE_EXPOSURE_END' is supported
}
