Back to Adaptive Vision Library website
You are here: Start » Function Reference » IFM » IFM_GrabImage
Captures an image from an ifm device.
Syntax
bool avl::IFM_GrabImage ( Ifm_State& ioState, const avl::IFMCameraAddress& inAddress, bool inGrab3dCoordinates, const atl::Optional<atl::real>& inFrameRate, const atl::Optional<avl::IFMResolution::Type>& inResolution, const atl::Optional<avl::IFMTriggerMode::Type>& inTriggerMode, avl::Image& outDistancesImage, avl::Image& outAmplitudeImage, atl::Array<avl::Region>& outInvalidRois, atl::Conditional<avl::Point3DGrid>& out3dCoordinates )
Parameters
| Name | Type | Range | Default | Description | |
|---|---|---|---|---|---|
| ioState | Ifm_State& | Object used to maintain state of the function. | |||
![]() |
inAddress | const IFMCameraAddress& | Device identifying address | ||
![]() |
inGrab3dCoordinates | bool | Enable 3d coordinates capturing | ||
![]() |
inFrameRate | const Optional<real>& | 0.017 - 300.0 | NIL | Sets the target frame rate in fps at which device should capture images |
![]() |
inResolution | const Optional<IFMResolution::Type>& | NIL | Sets the resolution of output image | |
![]() |
inTriggerMode | const Optional<IFMTriggerMode::Type>& | NIL | Sets the trigger mode on device for capturing image | |
![]() |
outDistancesImage | Image& | Captured distance image | ||
![]() |
outAmplitudeImage | Image& | Captured amplitude image | ||
![]() |
outInvalidRois | Array<Region>& | Region array with invalid pixels: INVALID, SATURATED, INCONSISTENT and LOW_SIGNAL. | ||
![]() |
out3dCoordinates | Conditional<Point3DGrid>& | Captured 3d coordinates |
Remarks
Device driver software
This filter is intended to cooperate with device using PMDSDK 2. In order to connect with the device, it is required to install PMDSDK 2.
PMDSDK 2 can be downloaded from the following website: http://www.ifm.com/ifmus/web/dualis-download.htm. Please download "O3D303 Software Development Kit"
After download you have to manually copy pmdaccess2.dll file to Adaptive Vision Studio main directory.
Additionally in inAddress input you will need to provide device configuration and processing dll file path.
It is recommended to disable DHCP in the device and using static IP address.
Multithreaded environment
This function is not guaranteed to be thread-safe. When used in multithreaded environment, it has to be manually synchronized.


