You are here: Start » Function Reference » Camera Support » JAI » JAI_GrabImage

JAI_GrabImage

Header:	ThirdPartySdk.h
Namespace:	avl
Module:	ThirdParty

Captures an image using a JAI device.

Syntax

bool avl::JAI_GrabImage
(
	JAI_State& ioState,
	atl::Optional<const atl::String&> inDeviceID,
	int inInputQueueSize,
	atl::Optional<avl::EBUSPixelFormat::Type> inPixelFormat,
	atl::Optional<const avl::Box&> inAoi,
	atl::Optional<avl::EBUSAcquisitionMode::Type> inAcquisitionMode,
	atl::Optional<int> inAcquisitionFrameCount,
	atl::Optional<double> inFrameRate,
	atl::Optional<avl::EBUSAutoExposureMode::Type> inExposureAuto,
	atl::Optional<double> inExposureTime,
	atl::Optional<avl::EBUSAutoGainMode::Type> inGainAuto,
	atl::Optional<double> inGain,
	atl::Optional<avl::EBUSTriggerSource::Type> inTriggerSource,
	atl::Optional<avl::EBUSTriggerActivation::Type> inTriggerActivation,
	bool inSkipInvalidFrames,
	avl::Image& outImage,
	avl::EBUSFrameData& outFrameData
)

Parameters

Name	Type	Range	Default	Description
ioState	JAI_State&			Object used to maintain state of the function.
inDeviceID	Optional<const String&>		NIL	Device identifying number
inInputQueueSize	int	1 -	12	Capacity of output frames queue
inPixelFormat	Optional<EBUSPixelFormat::Type>		NIL	Image pixel format
inAoi	Optional<const Box&>		NIL	Area of interest
inAcquisitionMode	Optional<EBUSAcquisitionMode::Type>		NIL	Acquisition mode
inAcquisitionFrameCount	Optional<int>	1 - 65535	NIL	Number of frames to acquire in MultiFrame acquisition mode
inFrameRate	Optional<double>	0.125 -	NIL	Acquisition frame rate
inExposureAuto	Optional<EBUSAutoExposureMode::Type>		NIL	Automatic exposure mode
inExposureTime	Optional<double>	1 -	NIL	Exposure time in us
inGainAuto	Optional<EBUSAutoGainMode::Type>		NIL	Automatic gain mode
inGain	Optional<double>	1 -	NIL	Gain as an absolute physical value
inTriggerSource	Optional<EBUSTriggerSource::Type>		NIL	Trigger source
inTriggerActivation	Optional<EBUSTriggerActivation::Type>		NIL	Trigger activation mode
inSkipInvalidFrames	bool		True	Skipping invalid images
outImage	Image&			Captured frame
outFrameData	EBUSFrameData&			Captured frame data

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 eBUS SDK for JAI software with camera dedicated drivers.

eBUS SDK for JAI can be downloaded from the following website: https://www.jai.com/support-software/jai-software.

Recommended eBUS SDK for JAI version for Aurora Vision Studio usage is 6.3.0.

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, the first available camera will be found and connected.

inDeviceID field can be used to pick one of multiple cameras connected to the computer. DeviceID can be set to:

Serial Number - should be printed on the device housing.
Device ID - unique device identifier.
IP Address - network IP address of device.
MAC Address - MAC address of device.

Camera parameters

To change other and more advanced internal camera parameters use the "eBUS Player for JAI" tool which could be installed with the eBUS SDK for JAI.