You are here: Start » Filter Reference » The Imaging Source » ICImagingControl_GrabImage_WithTimeout
ICImagingControl_GrabImage_WithTimeout
Captures a frame from The Imaging Source cameras using ICImagingControl.
| Name | Type | Range | Description | |
|---|---|---|---|---|
 |
inDeviceID | String* | Serial number, display name, unique name or base name of the camera | |
|
inInputQueueSize | Integer | 1 - + |
|
|
inTimeout | Integer | Maximum time to wait for frame in milliseconds | |
|
inPixelFormat | ICImagingControlColorFormat | Pixel format | |
|
inBinning | Integer* | 2 - 64 | Skipping factor |
|
inSkipping | Integer* | 2 - 64 | Binning factor |
|
inRoi | Box* | Hardware Region of Interest | |
|
inFrameRate | Real* | 0.5 - |
Camera frame rate |
|
inGain | Integer* | 0 - + |
Gain value |
|
inGainAuto | Bool* | Enable auto gain | |
|
inExposure | Double* | Exposure time | |
|
inExposureAuto | Bool* | Enable auto exposure | |
|
inGamma | Integer* | 0 - + |
Gamma value |
|
inSharpness | Integer* | 0 - + |
Sharpness value |
 |
outImage | Image? | Captured frame | |
|
outFrameID | Long? | Captured frame ID | |
Remarks
Camera driver software
This filter is intended to cooperate with a camera using its vendor SDK. To be able to connect to a camera, it is required to install ICImagingControl SDK software. Currently FabImage Studio requires ICImagingControl SDK version 3.4.
Proper camera drivers and ICImagingControl SDK (IC Imaging Control .NET Component, C++ Class Library ) can be downloaded from the following website:
https://www.theimagingsource.com/support/downloads-for-windows/.
To work with the Imaging Source SDK you need to install SDK on the target machine or copy manually the .dll files from the Documents\IC Imaging Control 3.4\redist\c++\win32\ directory on your computer
(or Documents\IC Imaging Control 3.4\redist\c++\x64\ if you use FabImage Studio x64) and add them to the FabImage Studio directory in Program Files.
Camera identification
When there is only one camera connected to the computer, field inDeviceID can be set to Auto. In such case, the first available camera will be found and connected.
inDeviceID can be used to pick one of multiple cameras connected to the computer. inDeviceID can be set to:
- serial number,
- display name,
- unique name,
- base name of the camera.
Camera parameters
Most of the parameters exposed by camera filters are optional, setting them to Auto leaves related parameter for automatic configuration by the camera driver.
To change other and more advanced camera parameters, use the VCD Property Inspector available with ICImagingControl SDK. Refer to SDK documentation for information about parameters and how to save them into memory channels.
Complexity Level
This filter is available on Basic Complexity Level.
Filter Group
This filters is member of ICImagingControl_GrabImage filter group.
