IDS peak 2.10.0 / uEye+ firmware 3.34

IDS Peak comfortSDK, genericSDK, IPL, and AFL developer manuals are external documents. Please contact us if you need them.

This chapter contains the descriptions of all supported features from the Acquisition Control category.

Here you will find all the functions for:

•acquisition

•image ("frame")

•use of triggers

•exposure control

Image capture functions

•AcquisitionMode: Defines the capture mode, i.e. whether a single image ("SingleFrame") is captured, whether a defined number of images ("MultiFrame") are to be captured, or whether image capture is done continuously ("Continuous").

•AcquisitionStart: Starts the acquisition.

•AcquisitionStop Stops the acquisition of the camera at the end of the current frame. AcquisitionStop can be used in any AcquisitionMode.

•AcquisitionAbort: Stops image acquisition without finishing the current frame.

•AcquisitionFrameCount: Defines the number of frames to capture when AcquisitionMode = "MultiFrame". The number of captured frames is monitored by the camera. This means that if an image is lost in transit, one less image will arrive at the host. This can happen, for example, if the application does not provide enough buffer memory for the transport layer.

•AcquisitionFrameRate: Controls the frame rate, i.e. the number of frames captured per second, if TriggerMode = "Off".

•AcquisitionLineRate: Controls the line rate, i.e. the number of lines that are recorded per second, assumed that TriggerMode = "Off". You only need this function in SensorOperationMode "Linsescan".

IDS image capture functions that extend the SFNC standard:

•AcquisitionFrameRateTargetEnable: Enables or disables the frame rate capture control via AcquisitionFrameRateTarget, i.e. the desired number of frames to capture per second as possible.

•AcquisitionFrameRateTarget: Specifies the desired target frame rate. The camera will approximate the actual frame rate as closely as possible to the frame rate entered here without exceeding it. If an ExposureStart trigger is active, this function has no effect.

For more information see the chapter Image acquisition mode.

Trigger functions

You can use triggers to control the start of an acquisition or of individual frames. You can also use triggers to control the exposure time at the beginning of a frame. The following trigger functions are available:

•TriggerSelector: Use the TriggerSelector to choose which type of trigger (e.g. "AcquisitionStart" or "ExposureEnd") you configure.

•TriggerMode: Activates or deactivates the trigger mode.

•TriggerSource: Defines the signal source on which the trigger signal is expected (e.g. "Software" or "Line0").

•TriggerSoftware: Use this command to generate an internal trigger signal when TriggerSource = "Software". For more information see the chapter Software trigger.

•TriggerActivation defines at which signal state the trigger should be activated, e.g. at rising or falling edge ("RisingEdge" or "FallingEdge"). For more information see the chapter Hardware trigger.

•TriggerDelay: specifies the delay between the reception of the trigger signal and the trigger activation.

•The TriggerDivider specifies whether each of the incoming trigger signals is to be used, or whether only every xth trigger signal is to be used.

IDS trigger functions that extend the SFNC standard:

•TriggerControlledExposureTimeMin: Defines the minimum exposure time when the end of exposure is controlled by the trigger (ExposureMode = "TriggerControlled" and TriggerSelector = "ExposureEnd"). If a trigger is received before the minimum exposure time, the exposure will not end until the minimum exposure time has been reached. Helpful for sensors with overlapping image acquisition.

•TriggerControlledExposureTimeMax: Defines the maximum exposure time allowed when the end of exposure is controlled by the trigger (ExposureMode = "TriggerControlled" and TriggerSelector = "ExposureEnd"). The exposure is ended after reaching the maximum exposure time if no trigger was registered before.

Exposure control functions

•ExposureMode: Defines the exposure mode. Use timed exposure ("Timed") if you want to control exposure time via ExposureTime or ExposureAuto. Use "TriggerControlled" exposure if you want to control the exposure time independently of the current frame or line triggers via one or more trigger signals (see "ExposureStart" and "ExposureEnd" in the TriggerSelector).

•ExposureAuto: Enables/disables automatic timed exposure, with the following auto functions available to you:
Off: The automatic timed exposure is deactivated.
Once: The exposure time is adjusted once to the current conditions. The automatic timed exposure is deactivated afterwards.
Continuous: The automatic timed exposure is permanently activated, the exposure time is automatically adjusted in changing light conditions.

•With ExposureTime you define the duration in which the sensor is exposed. With ExposureTime you set the exposure time for a timed exposure (ExposureMode = "Timed"), if you do not want to use ExposureAuto.

Sensor Mode

•In SensorShutterMode the sensor type of the camera is returned, e.g. global shutter or rolling shutter.