AILDigitizer_GrabMultiPartImage

Header:	ThirdPartySdk.h
Namespace:	avl

Captures a multi-part image from the digitizer. Allows to receive multi-part video stream (with multiple images per frame) from multi-component devices, like separate depth, confidence and luminosity images in 3D cameras.

Syntax

bool avl::AILDigitizer_GrabMultiPartImage
(
	AIL_DigitizerState& ioState,
	atl::Optional<const avl::AILSystemAndDeviceIdentifierDigitizer&> inDeviceID,
	int inInputQueueSize,
	int inTimeout,
	bool inSkipInvalidFrames,
	atl::Conditional<avl::Image>& outFramePart1,
	atl::Conditional<avl::Image>& outFramePart2,
	atl::Conditional<avl::Image>& outFramePart3,
	atl::Conditional<avl::Image>& outFramePart4,
	atl::Conditional<avl::AILFrameInformation>& outFrameData,
	atl::Conditional<atl::sint64>& outFrameID,
	atl::Conditional<atl::sint64>& outTimestamp
)

Parameters

Name	Type	Range	Default	Description
ioState	AIL_DigitizerState&			Object used to maintain state of the function.
inDeviceID	Optional<const AILSystemAndDeviceIdentifierDigitizer&>		NIL	Device identification.
inInputQueueSize	int	1 -	12	Capacity of output frames queue.
inTimeout	int	100 -	5000	Maximum time to wait for frame in milliseconds.
inSkipInvalidFrames	bool		True	Skips invalid frames.
outFramePart1	Conditional<Image>&			First part of the captured frame.
outFramePart2	Conditional<Image>&			Second part of the captured frame.
outFramePart3	Conditional<Image>&			Third part of the captured frame.
outFramePart4	Conditional<Image>&			Fourth part of the captured frame.
outFrameData	Conditional<AILFrameInformation>&			Frame data of the captured frame.
outFrameID	Conditional<sint64>&			Frame ID set by the device.
outTimestamp	Conditional<sint64>&			Frame capture timestamp set by the device.

Remarks

I/O device driver software

This filter is intended to cooperate with AIL digitizer systems:

GigeVision - can work with cameras connected by Ethernet cable;
GenTL - AIL specific devices like Matrox CoaXPress GenTL Producer;
USB3Vision - can work with cameras connected by USB3 cable;
RapixoCxp and RapixoCL - Rapixo frame grabbers for CoaXPress and Camera Link protocols;
IrisGTX - Iris GTX Smart Camera;

To be able to connect to the device, it is required to install Zebra AIL X SDK (Lite or Full version).

Adding the DLL path to system environment variables may be required.

Recommended Zebra AIL X SDK version for Aurora Vision Studio usage is V23H2 (10.70.0963).

Device identification

System field is used to specify camera protocol.

Host
GigeVision
GenTL
USB3Vision
RapixoCxp
RapixoCL
IrisGTX

Device field specifies the hardware board identifier within the selected system. Device can be set to:

DEFAULT - Specifies the default board. The default board is set in the MILConfig utility.
DEVn - Specifies the device number (rank) of the board (where 0 <= n <=15).

GenTLProducerIndex field is used to specify the index of the GenTL Producer - index is between 0 and 127. It is used only when System is set to GenTL.

Digitizer field specifies how the camera should be accessed. Digitizer can be set to:

DEFAULT - Specifies the default board. The default board is set in the MILConfig utility.
DEVn - Specifies the device number (rank) of the board (where 0 <= n <=15).
CamIp - Specifies that camera should connect using its IP address.
CamName - Specifies that camera should connect using its name.

CamID field is used when Digitizer is set to CamIp or CamName.

Note: It is strongly recommended to set the appropriate Device and Digitizer parameter to avoid communication issues.

Warning:All tools applied to a specific device or file should be managed within a single thread to ensure centralized tracking, traceability, and consistency throughout the process.