You are here: Start » Filter Reference » IDS » IDS_StartAcquisition
IDS_StartAcquisition
Initializes and starts image acquisition in a camera
| Name | Type | Range | Description | |
|---|---|---|---|---|
 |
inDeviceID | String* | Device serial number or user definable camera ID | |
|
inPixelFormat | String | Pixel format. Supported values: Raw8, Mono8, Rgb8, Bgr8, Rgba8, Bgra8 | |
|
inInputQueueSize | Integer | 1 -  |
Capacity of input frames queue |
|
inAutoReconnect | Bool | Automatically reconnect with the camera | |
|
inTriggerMode | IDSTriggerMode* | Camera trigger mode | |
|
inAoi | Box* | Required fragment of image to stream | |
|
inFrameRate | Real* | 0.1 - 400.0 | Frame rate |
|
inExposureTime | Real* | 0.0 - |
Exposure time in microseconds |
|
inHorizontalBinning | IDSBinning* | Horizontal binning | |
|
inVerticalBinning | IDSBinning* | Vertical binning | |
|
inMirror | IDSMirror* | Mirror effect | |
|
inAutoBlackLevel | Bool* | Enable auto black level | |
|
inBlackLevelOffset | Integer* | 0 - |
Black level offset |
|
inGamma | Integer* | 1 - 1000 | Set gamma value |
|
inGainBoost | Bool* | Set gain boost mode | |
|
inGainMaster | Integer* | 0 - 100 | Set gain master value |
|
inGainRed | Integer* | 0 - 100 | Set gain red value |
|
inGainGreen | Integer* | 0 - 100 | Set gain green value |
|
inGainBlue | Integer* | 0 - 100 | Set gain blue value |
Remarks
Camera driver software
This filter is intended to cooperate with cameras using their vendor's SDK. In order to connect with the camera, it is required to install IDS SDK software.
IDS SDK can be downloaded from the following website: https://en.ids-imaging.com/download-ueye.html
To verify the driver installation, you can run IDS Camera Manager. If the camera was detected and you can see the view from the camera, you can use IDS SDK in FabImage Studio.
Recommended IDS SDK version for FabImage Studio usage is 4.90.
Camera identification
When there is only one IDS camera connected, the field inDeviceID can be set to Auto. In this situation, the first available camera will be used.
inDeviceID can be used to pick one of multiple cameras connected to the computer. inDeviceID should be set to camera ID.
Source code
In Professional edition this filter is open source. You can use this filter as reference when implementing support for your specific hardware. You can also modify this filter and add some additional functionality.
The source code is located in the directory:
\My Documents\FabImage Studio 4.x Professional\Sources\User Filters\IDS
Working with camera
If you work with USB cameras then parameter inAutoReconnect doesn't work. Camera disconnection also can't be detected. To enable these features in USB cameras please add new register key:
HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\services\ueye\Parameters DWORD DevChangeHandlerMode = 1
Complexity Level
This filter is available on Basic Complexity Level.
