cxCam_GrabData

Header:	ThirdPartySdk.h
Namespace:	avl

Captures a frame using cxCam Support Package.

Syntax

bool avl::cxCam_GrabData
(
	cxCam_State& ioState,
	atl::Optional<const atl::String&> inDeviceID,
	int inInputQueueSize,
	const avl::CxCamModeAndAlgorithmConfiguration& inModeAndAlgorithm,
	avl::CxCamImagePixel::Type inPixel,
	avl::CxCamScannerMode::Type inScannerMode,
	avl::CxCamAcquisitionMode::Type inAcquisitionMode,
	atl::Optional<avl::CxCamTriggerMode::Type> inTriggerMode,
	atl::Optional<avl::CxCamTriggerSequencerMode::Type> inSequencerMode,
	atl::Array<avl::CxCamAOIOutput>& outAOI
)

Parameters

Name	Type	Range	Default	Description
ioState	cxCam_State&			Object used to maintain state of the function.
inDeviceID	Optional<const String&>		NIL	Device URI
inInputQueueSize	int	3 - 200	4	Capacity of output frames queue
inModeAndAlgorithm	const CxCamModeAndAlgorithmConfiguration&			3D algorithm configuration.
inPixel	CxCamImagePixel::Type			Output pixel type.
inScannerMode	CxCamScannerMode::Type			Scanner mode.
inAcquisitionMode	CxCamAcquisitionMode::Type			AcquisitionMode.
inTriggerMode	Optional<CxCamTriggerMode::Type>		NIL	Trigger mode.
inSequencerMode	Optional<CxCamTriggerSequencerMode::Type>		NIL	Trigger sequencer mode.
outAOI	Array<CxCamAOIOutput>&			Output data. Usually one item.

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 cxCam Support Package software with camera dedicated drivers.

Package can be downloaded from the following website: https://www.automationtechnology.de/cms/en/support-packages/ (registration may be required).

Add DLL path to system environment variable may be required. The SDK is divided into several directories with shared libraries - you have to add them all.

You should install the transport layer from Common Vision Box Runtime. The lack of this component may cause the application to behave unexpectedly.

Installing special network transport transport layer from vendor may be required.

Recommended cxCam Support Package version for Aurora Vision Studio usage is 01.08.2017.

32-bit platform is not supported.

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:

URI - should be specified on device casing.

Camera parameters

Setting inInputQueueSize parameter to 'Auto' will select four value as input queue size.

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).

To change other, more advanced camera parameters, use specific filters.