You are here: Start » Function Reference » Allied Vision Technologies » FirePackage_GrabImage_Deprecated
FirePackage_GrabImage_Deprecated
Captures a frame from Allied Vision cameras using FirePackage.
Syntax
bool avl::FirePackage_GrabImage_Deprecated ( FirePackage_GrabImage_DeprecatedState& ioState, atl::Optional<const atl::String&> inDeviceGUID, avl::FirePackageISOSpeed::Type inISOSpeed, atl::Optional<const avl::Box&> inAoi, avl::FirePackageResolution::Type inResolution, avl::FirePackageColorMode::Type inColorMode, avl::FirePackageTriggerMode::Type inTriggerMode, avl::FirePackageFrameRate::Type inFrameRate, atl::Optional<int> inShutter, atl::Optional<int> inGain, atl::Optional<int> inTimeout, avl::Image& outImage )
Parameters
| Name | Type | Range | Default | Description | |
|---|---|---|---|---|---|
| ioState | FirePackage_GrabImage_DeprecatedState& | Object used to maintain state of the function. | |||
 |
inDeviceGUID | Optional<const String&> | NIL | Source device GUID | |
|
inISOSpeed | FirePackageISOSpeed::Type | Isochronous transmission speed | ||
|
inAoi | Optional<const Box&> | NIL | Required fragment of image to stream. Can't set frame rate | |
|
inResolution | FirePackageResolution::Type | Image resolution | ||
|
inColorMode | FirePackageColorMode::Type | Image color mode | ||
|
inTriggerMode | FirePackageTriggerMode::Type | Camera trigger mode | ||
|
inFrameRate | FirePackageFrameRate::Type | _30 | Requested camera frame rate | |
|
inShutter | Optional<int> | 0 - + |
NIL | Shutter time |
|
inGain | Optional<int> | 0 - + |
NIL | Image preamplifiers gain |
|
inTimeout | Optional<int> | 0 - + |
100 | Maximum wait time for camera frame |
 |
outImage | Image& | Captured frame |
Remarks
Camera driver software
This filter is intended to cooperate with camera using its vendor SDK. To be able to connect with camera it is required to install AVT FirePackage SDK software with camera dedicated drivers.
AVT FirePackage SDK can be downloaded from following website: www.alliedvisiontec.com.
Recommended AVT FirePackage SDK version for Adaptive Vision Studio usage is v3.1.
Camera identification
When there is only one camera connected with computer field inDeviceGUID can be set to Auto. In this situation first available camera will be found and connected.
inDeviceGUID can be used to pick one of multiple cameras connected to computer. In this situation, inDeviceGUID should be set to device GUID number.
Camera parameters
Most of parameters exposed by camera filters are optional, setting them to 'Auto' leaves related parameter for automatic configuration by camera driver.
To change other and more advanced camera parameters use configuration tool "AVT SmartView" available with AVT FirePackage SDK. Refer to SDK documentation to find information about parameters and how to save parameters into memory channels.
