You are here: Start » Function Reference » Microview » Microview_GrabImage
Header: | ThirdPartySdk.h |
---|---|
Namespace: | fil |
Captures a frame using Microview.
Syntax
bool fil::Microview_GrabImage ( Microview_State& ioState, const ftl::Optional<int> inDeviceID, int inInputQueueSize, bool inJumboFrameSupport, bool inRescanNeeded, const fil::MicroviewUsersSettingsParams& inUsersSettingsParams, const fil::MicroviewImageFormatParams& inImageFormat, const fil::MicroviewAcquisitionParams& inAcquisitionControl, const fil::MicroviewTriggerParams& inTriggerControl, fil::Image& outImage, int& outFrameId )
Parameters
Name | Type | Range | Default | Description | |
---|---|---|---|---|---|
ioState | Microview_State& | Object used to maintain state of the function. | |||
![]() |
inDeviceID | const Optional<int> | 0 - 10000 | NIL | Device identifying number |
![]() |
inInputQueueSize | int | 1 - 200 | 4 | Capacity of output frames queue |
![]() |
inJumboFrameSupport | bool | True | ||
![]() |
inRescanNeeded | bool | |||
![]() |
inUsersSettingsParams | const MicroviewUsersSettingsParams& | |||
![]() |
inImageFormat | const MicroviewImageFormatParams& | |||
![]() |
inAcquisitionControl | const MicroviewAcquisitionParams& | |||
![]() |
inTriggerControl | const MicroviewTriggerParams& | |||
![]() |
outImage | Image& | Captured frame | ||
![]() |
outFrameId | int& | 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 MVGESDK software with camera dedicated drivers.
MVGESDK can be downloaded from the following website: http://www.microview.com.cn (registration may be required).
Recommended MVGESDK version for FabImage Studio usage is 2.8.
Add DLL path to system environment variable may be required.
Camera identification
When there is only one camera connected to a computer, field inDeviceID can be set to Auto. In this case, first available camera will be found and connected.
inDeviceID field can be used to pick one of multiple cameras connected to computer. DeviceID can be set to:
- Device number - should be specified on device casing.
Camera parameters
Setting inJumboFrameSupport parameter to 'true' will select maximum possible camera package size.
Setting inRescanNeeded parameter to 'true' will rescan network to search new cameras.
All the other parameters exposed by camera filters are optional, setting them to 'Auto' leaves related parameter unchanged in camera (device default or user set configuration).
Multithreaded environment
See Also
- Microview_GrabImage_WithTimeout – Captures with timeout a frame using Microview.
- Microview_StartAcquisition – Start acquisition using Microview.