Inheritance diagram for VIB_NET::CameraLinkIn:

Detailed Description

This class represents the Camera Link grabber module.

See class VIB::CameraLinkIn in the VisionBox Interface Library for a detailed description.

Image acquisition example in C#

This example demonstrates a simple use case for acquiring images from a camera.

The following assumptions are made:

A camera is connected on the first Camera Link connector
The camera is running in free-run mode
The delivers images with 8-bit Camera Link Base configuration and a resolution of at least VGA (640x480)

VIB_NET.VIBSystem    pSysCLCard = null;
VIB_NET.CameraLinkIn pCLIn      = null;
IntPtr               pBuffer    = IntPtr.Zero;
const UInt16         Width      = 640;
const UInt16         Height     = 480;
const UInt32         INFINITE   = UInt32.MaxValue;
 
 
//>Open...
//System, we need the AddOn system
pSysCLCard = new VIB_NET.VIBSystem(VIB_NET.eSYSTEM_TYPE.CL, 0);
 
//Device
pCLIn = (VIB_NET.CameraLinkIn) pSysCLCard.OpenDevice(VIB_NET.eDEVICE_TYPE.CAMERALINK_INPUT,0);
 
 
//>Configure 
//switch the CL card into the BaseMode
pCLIn.ConfigureModule(VIB_NET.CameraLinkIn.eMODULE_CONFIGURATION.BASE);
 
//set the image size, the AOI and the byte order/format
pCLIn.ConfigureCLInput(
            0,                                                //ChannelIndex
            VIB_NET.CameraLinkIn.eINMODE_TYPE.MODE_1TAP_8BIT, //InModeType
            VIB_NET.CameraLinkIn.eINMODE_FLAGS.FLAGS_DEFAULT, //InModeFlags
            Width,  //Width of the complete camera image
            Height, //Height of the complete camera image
            0,      //AOI_X
            0,      //AOI_Y
            Width,  //AOI_Width
            Height  //AOI_Height
        );
 
//allocate 1 image buffer
pBuffer = pCLIn.AllocateImageBuffer(0);
 
 
//>Start capturing 10 images
for(int i=0; i<10; i++)
{
    //add the buffer into the internal queue, 
    //directly after this call, the Lib will fill the buffer with the next camera image
    pCLIn.AddImageBufferForCapturing(0, //ChannelIndex
                                     pBuffer);
 
    //wait for the image
    bool IsImgValid = false;
    pBuffer = pCLIn.WaitForImageBuffer(0,             //ChannelIndex
                                       INFINITE,      //0 <> no wait, wait time [ms] or wait forever 
                                       ref IsImgValid //on success, contains the health of the image buffer
                 );
 
 
    //>Work with the imagedata
    Byte[] workBuffer = new Byte[Width * Height];
    System.Runtime.InteropServices.Marshal.Copy(pBuffer, workBuffer, 0, Width * Height);
    for(int pos=0; pos<(Width+Height); pos++)
        workBuffer[pos] = (Byte)~workBuffer[pos];
    // . . . 
}
 
 
//>CleanUp
//free the image buffer
pCLIn.FreeImageBuffer(0, //ChannelIndex
                      pBuffer);
 
//Device...
pSysCLCard.CloseDevice(pCLIn);

Camera trigger example in C#

The internal TriggerGenerator is configured to generate a 10 Hz signal and then used as camera trigger on the CC1 line.

VIB_NET.VIBSystem   pSysBaseBoard = null;
VIB_NET.VIBSystem   pSysCLCard    = null;
 
VIB_NET.Multiplexer      pMux     = null;
VIB_NET.TriggerGenerator pTriggerGenerator = null;
VIB_NET.CameraLinkIn     pCLIn    = null;
 
//>Open...
//Systems, we have 2 item, the BaseBoard (default) and the AddOn-CL system
pSysBaseBoard = new VIB_NET.VIBSystem(VIB_NET.eSYSTEM_TYPE.BASEBOARD, 0);
pSysCLCard = new VIB_NET.VIBSystem(VIB_NET.eSYSTEM_TYPE.CL, 0);
 
//Devices, we need 3, Multiplexer, TriggerGen and the CL-Unit,
pMux = (VIB_NET.Multiplexer) pSysBaseBoard.OpenDevice(VIB_NET.eDEVICE_TYPE.MULTIPLEXER,0);
pTriggerGenerator = (VIB_NET.TriggerGenerator) pSysBaseBoard.OpenDevice(VIB_NET.eDEVICE_TYPE.TRIGGER_GENERATOR,0);
pCLIn = (VIB_NET.CameraLinkIn) pSysCLCard.OpenDevice(VIB_NET.eDEVICE_TYPE.CAMERALINK_INPUT,0);
 
 
//>Configure 
//TriggerGenerator to 10Hz
pTriggerGenerator.ConfigureSet("GenA_tLow=50ms GenA_tHigh=50ms TrigOut0_Mux=GenA");
 
//Multiplexer, use the first MuxOut for the first TrigGenOut
pMux.ConnectOutput(0, VIB_NET.Multiplexer.eMUX_SOURCE.TRIGGEN_OUT0);
 
//CL
//switch the CL card into the BaseMode
pCLIn.ConfigureModule(VIB_NET.CameraLinkIn.eMODULE_CONFIGURATION.BASE);
//set the input(channel) configuration, the exact values are irrelevant for this example they must be only valid, 
pCLIn.ConfigureCLInput(0, VIB_NET.CameraLinkIn.eINMODE_TYPE.MODE_1TAP_8BIT,
                       VIB_NET.CameraLinkIn.eINMODE_FLAGS.FLAGS_DEFAULT, 320, 240, 0, 0, 320, 240);
//after ConfigureModule() and ConfigureCLInput() 
pCLIn.ConfigureCC(0, //ChannelIndex  
                  1, //CC-Line Index, first line is number 1  
                  VIB_NET.CameraLinkIn.eCC_SOURCE.MUX_OUT0,  //source for the CC line
                  false  //Invert
         );
 
// . . .
 
 
//>CleanUp
//Devices...
pSysBaseBoard.CloseDevice(pMux);
pSysBaseBoard.CloseDevice(pTriggerGenerator);
pSysCLCard.CloseDevice(pCLIn);

Public Types
enum	eCC_SOURCE
	Source signal definition for the Camera Link CC lines, used by ConfigureCC() More...

enum	eINMODE_FLAGS
	Special or additional configuration modes, used by ConfigureCLInput() More...

enum	eINMODE_TYPE
	The data organization on the Camera Link cable, used by ConfigureCLInput() More...

enum	eMODULE_CONFIGURATION
	Type of Camera Link module configuration, used by ConfigureModule() and GetNumberOfInputs() More...

Public Member Functions
void	AbortBufferUsage (const UInt32 ChannelIndex)
	Force the driver to stop using any added buffer immediately More...

void	AbortWaitingForDMA (const UInt32 ChannelIndex)
	Force every waiting thread to return from the WaitForImageBuffer() function call More...

void	AddImageBufferForCapturing (const UInt32 ChannelIndex, IntPtr ptr)
	Add a previously allocated buffer into a queue for capturing image data into More...

IntPtr	AllocateImageBuffer (const UInt32 ChannelIndex)
	Allocate a proper image buffer for capturing More...

	CameraLinkIn ()
	Default constructor for the device object More...

void	ConfigureCC (const UInt32 ChannelIndex, const UInt32 CCIndex, const CameraLinkIn::eCC_SOURCE src, const bool Invert)
	Select the source for the given CameraLink-CC line More...

void	ConfigureCLInput (const UInt32 ChannelIndex, const CameraLinkIn::eINMODE_TYPE InType, const CameraLinkIn::eINMODE_FLAGS InFlags, const UInt16 Width, const UInt16 Height, const UInt16 AOI_X, const UInt16 AOI_Y, const UInt16 AOI_Width, const UInt16 AOI_Height)
	Configures a camera channel More...

void	ConfigureCLInput (const UInt32 ChannelIndex, const CameraLinkIn::eINMODE_TYPE InType, const CameraLinkIn::eINMODE_FLAGS InFlags, const UInt32 AOI_Width, const UInt32 AOI_Height)
	Configures a camera channel More...

void	ConfigureCLInput (const UInt32 ChannelIndex, const CameraLinkIn::eINMODE_TYPE InType, const CameraLinkIn::eINMODE_FLAGS InFlags, const UInt32 AOI_Width, const UInt32 AOI_Height, const UInt32 AOI_X, const UInt32 AOI_Y)
	Configures a camera channel More...

void	ConfigureModule (const CameraLinkIn::eMODULE_CONFIGURATION ModuleConfig)
	Configure the module to the given mode More...

void	FreeImageBuffer (const UInt32 ChannelIndex, IntPtr ptr)
	Frees the specified buffer More...

void	GetAOI (const UInt32 ChannelIndex, UInt32 % AOI_X, UInt32 % AOI_Y, UInt32 % AOI_Width, UInt32 % AOI_Height)
	Returns the configured AOI size. More...

void	GetBitsPerPixel (const UInt32 ChannelIndex, UInt32 % ValidBits, UInt32 % BufferBits)
	Returns the number of bits for each pixel. More...

void	GetBufferSize (const UInt32 ChannelIndex, UInt32 % Bytes)
	Returns the number of bytes allocated for each image buffer. More...

UInt32	GetNumberOfInputs (const CameraLinkIn::eMODULE_CONFIGURATION ModuleConfig)
	Returns the number of independent Camera Link input channels More...

void	Reset ()
	Resets the device to default settings. More...

IntPtr	WaitForImageBuffer (const UInt32 ChannelIndex, const UInt32 msTimeOut, bool % IsContentValid)
	Waits for completion of image buffers and transfers ownership to the user More...

IntPtr	WaitForImageBuffer (const UInt32 ChannelIndex, const UInt32 msTimeOut, bool % IsContentValid, UInt64 % timestamp)
	Waits for completion of image buffers and transfers ownership to the user More...

Public Member Functions inherited from VIB_NET::iDevice
void	Close ()
	Closes a device More...

bool	isOpen ()
	Returns the open state of a device object More...

void	Open ()
	Opens a device More...

void	Open (unsigned int Index)
	Opens a device More...

Properties
virtual VIB_NET::eDEVICE_TYPE	Type `[get]`
	Returns the device type for the current instance, see eDEVICE_TYPE More...

Properties inherited from VIB_NET::iDevice
virtual VIB_NET::eDEVICE_TYPE	Type `[get]`
	Returns the device type for the current instance, see eDEVICE_TYPE More...

Member Enumeration Documentation

◆ eCC_SOURCE

enum VIB_NET::CameraLinkIn::eCC_SOURCE

strong

Source signal definition for the Camera Link CC lines, used by ConfigureCC()

Enumerator
OFF	static off
ON	static on
MUX_OUT0	Multiplexer Output 0.
MUX_OUT1	Multiplexer Output 1.
MUX_OUT2	Multiplexer Output 2.
MUX_OUT3	Multiplexer Output 3.
MUX_OUT4	Multiplexer Output 4.
MUX_OUT5	Multiplexer Output 5.
MUX_OUT6	Multiplexer Output 6.
MUX_OUT7	Multiplexer Output 7.
MUX_OUT8	Multiplexer Output 8.
MUX_OUT9	Multiplexer Output 9.
MUX_OUT10	Multiplexer Output 10.
MUX_OUT11	Multiplexer Output 11.
MUX_OUT12	Multiplexer Output 12.
MUX_OUT13	Multiplexer Output 13.
MUX_OUT14	Multiplexer Output 14.
MUX_OUT15	Multiplexer Output 15

◆ eINMODE_FLAGS

enum VIB_NET::CameraLinkIn::eINMODE_FLAGS

strong

Special or additional configuration modes, used by ConfigureCLInput()

Enumerator
FLAGS_DEFAULT	Use this value if no special behavior needed.
FLAGS_IGNORE_FVAL	Use this value for linescan cameras.
FLAGS_IGNORE_DVAL	Use this value to ignore the CL DVAL signal.

◆ eINMODE_TYPE

enum VIB_NET::CameraLinkIn::eINMODE_TYPE

strong

The data organization on the Camera Link cable, used by ConfigureCLInput()

Enumerator
MODE_1TAP_8BIT	The Image(Buffer) has the total size of AOI_Width * AOI_Height, one pixel is one byte long, delivered over one Tap.
MODE_1TAP_10BIT	The Image(Buffer) has the total size of 2 * AOI_Width * AOI_Height, one pixel is two bytes long, delivered over one Tap.
MODE_1TAP_12BIT	The Image(Buffer) has the total size of 2 * AOI_Width * AOI_Height, one pixel is two bytes long, delivered over one Tap.
MODE_1TAP_14BIT	The Image(Buffer) has the total size of 2 * AOI_Width * AOI_Height, one pixel is two bytes long, delivered over one Tap.
MODE_1TAP_16BIT	The Image(Buffer) has the total size of 2 * AOI_Width * AOI_Height, one pixel is two bytes long, delivered over one Tap.
MODE_2TAP_8BIT	The Image(Buffer) has the total size of AOI_Width * AOI_Height, one pixel is one byte long, delivered over two Taps.
MODE_2TAP_10BIT	The Image(Buffer) has the total size of 2 * AOI_Width * AOI_Height, one pixel is two bytes long, delivered over two Taps.
MODE_2TAP_12BIT	The Image(Buffer) has the total size of 2 * AOI_Width * AOI_Height, one pixel is two bytes long, delivered over two Taps.
MODE_3TAP_8BIT	The Image(Buffer) has the total size of AOI_Width * AOI_Height, one pixel is one byte long, delivered over three Taps.
MODE_1TAP_24BIT_RGB	The Image(Buffer) has the total size of 4 * AOI_Width * AOI_Height, one pixel is three bytes long (+ one unused byte), delivered over one Tap.
MODE_4TAP_8BIT	The Image(Buffer) has the total size of AOI_Width * AOI_Height, one pixel is one byte long, delivered over four Taps.
MODE_4TAP_10BIT	The Image(Buffer) has the total size of 2 * AOI_Width * AOI_Height, one pixel is two bytes long, delivered over four Taps.
MODE_4TAP_12BIT	The Image(Buffer) has the total size of 2 * AOI_Width * AOI_Height, one pixel is two bytes long, delivered over four Taps.
MODE_6TAP_8BIT	The Image(Buffer) has the total size of AOI_Width * AOI_Height, one pixel is one byte long, delivered over six Taps.
MODE_1TAP_30BIT_RGB	The Image(Buffer) has the total size of 8 * AOI_Width * AOI_Height, one pixel is six bytes long (+ one unused word), delivered over one Tap.
MODE_1TAP_36BIT_RGB	The Image(Buffer) has the total size of 8 * AOI_Width * AOI_Height, one pixel is six bytes long (+ one unused word), delivered over one Tap.
MODE_2TAP_24BIT_RGB	The Image(Buffer) has the total size of 4 * AOI_Width * AOI_Height, one pixel is three bytes long (+ one unused byte), delivered over two Taps.
MODE_8TAP_8BIT	The Image(Buffer) has the total size of AOI_Width * AOI_Height, one pixel is one byte long, delivered over eight Taps.
MODE_10TAP_8BIT	The Image(Buffer) has the total size of AOI_Width * AOI_Height, one pixel is one byte long, delivered over ten Taps.
MODE_8TAP_10BIT	The Image(Buffer) has the total size of AOI_Width * AOI_Height * 10 / 8, eight bytes containing the MSBs for eight pixels are followed by two bytes conaining the remaining two LSBs for these pixels.

◆ eMODULE_CONFIGURATION

enum VIB_NET::CameraLinkIn::eMODULE_CONFIGURATION

strong

Type of Camera Link module configuration, used by ConfigureModule() and GetNumberOfInputs()

Enumerator
BASE	CL-Base input, one cable for one camera.
MEDIUM	CL-Medium input, two cable for one camera.
FULL	CL-Full input, two cable for one camera.
DECA	CL-Deca input, two cables for one camera.

Constructor & Destructor Documentation

◆ CameraLinkIn()

VIB_NET::CameraLinkIn::CameraLinkIn ( )

Default constructor for the device object

The device must be opened with Open() before it can be used.

Member Function Documentation

◆ AbortBufferUsage()

void VIB_NET::CameraLinkIn::AbortBufferUsage ( const UInt32 ChannelIndex )

Force the driver to stop using any added buffer immediately

The driver delivers the buffers to the user by calling WaitForImageBuffer(). The buffers can then be accessed or freed by the user.

The grabber enters the reset state when calling this function. The unit has to be reinitialized again.

Parameters

ChannelIndex Camera index, use GetNumberOfInputs() to find the maximum

◆ AbortWaitingForDMA()

void VIB_NET::CameraLinkIn::AbortWaitingForDMA ( const UInt32 ChannelIndex )

Force every waiting thread to return from the WaitForImageBuffer() function call

Image acquisition and the buffers hold by the library are not affected.

Parameters

ChannelIndex Camera index, use GetNumberOfInputs() to find the maximum

◆ AddImageBufferForCapturing()

void VIB_NET::CameraLinkIn::AddImageBufferForCapturing	(	const UInt32	ChannelIndex,
		IntPtr	ptr
	)

Add a previously allocated buffer into a queue for capturing image data into

There is no rule, in which sequence the added buffers are used. After a call to this function, the buffer is controlled by the driver. Its not allowed to access or free this buffer until the buffer was delivered by the function WaitForImageBuffer().

Parameters

ChannelIndex	Camera index, use GetNumberOfInputs() to find the maximum
ptr	pointer to the image buffer

◆ AllocateImageBuffer()

IntPtr VIB_NET::CameraLinkIn::AllocateImageBuffer ( const UInt32 ChannelIndex )

Allocate a proper image buffer for capturing

The buffer has the correct size for one image. Refer to ConfigureCLInput() and eINMODE_TYPE which defines the buffer size.
It's not allowed to use a buffer with a channel which was allocated for a different channel. Furthermore, the buffer must be released by FreeImageBuffer() not by free() or delete().

Parameters

ChannelIndex Camera index, use GetNumberOfInputs() to find the maximum

Returns: Pointer to the new image buffer

◆ ConfigureCC()

void VIB_NET::CameraLinkIn::ConfigureCC	(	const UInt32	ChannelIndex,
		const UInt32	CCIndex,
		const CameraLinkIn::eCC_SOURCE	src,
		const bool	Invert
	)

Select the source for the given CameraLink-CC line

◆ ConfigureCLInput() [1/3]

void VIB_NET::CameraLinkIn::ConfigureCLInput	(	const UInt32	ChannelIndex,
		const CameraLinkIn::eINMODE_TYPE	InType,
		const CameraLinkIn::eINMODE_FLAGS	InFlags,
		const UInt16	Width,
		const UInt16	Height,
		const UInt16	AOI_X,
		const UInt16	AOI_Y,
		const UInt16	AOI_Width,
		const UInt16	AOI_Height
	)

Configures a camera channel

To reconfigure the channel, after the first call, the complete device has to be closed and opened again.

Parameters

ChannelIndex	Camera index, 0 ... GetNumberOfInputs()
InType	Define the desired Pixel/Data or streaming format
InFlags	Bitwise OR of configuration flags defined in eINMODE_FLAGS Use eINMODE_FLAGS::FLAGS_DEFAULT for area scan cameras and eINMODE_FLAGS::FLAGS_IGNORE_FVAL for line scan cameras
Width	The complete camera image width
Height	The complete camera image Height
AOI_X	Offset/start position inside the camera image
AOI_Y	Offset/start position inside the camera image
AOI_Width	Width of the returned image
AOI_Height	Height of the returned image

◆ ConfigureCLInput() [2/3]

void VIB_NET::CameraLinkIn::ConfigureCLInput	(	const UInt32	ChannelIndex,
		const CameraLinkIn::eINMODE_TYPE	InType,
		const CameraLinkIn::eINMODE_FLAGS	InFlags,
		const UInt32	AOI_Width,
		const UInt32	AOI_Height
	)

Configures a camera channel

To reconfigure the channel, after the first call, the complete device has to be closed and opened again.

Parameters

ChannelIndex	Camera index, 0 ... GetNumberOfInputs()
InType	Define the desired Pixel/Data or streaming format
InFlags	Bitwise OR of configuration flags defined in eINMODE_FLAGS Use eINMODE_FLAGS::FLAGS_DEFAULT for area scan cameras and eINMODE_FLAGS::FLAGS_IGNORE_FVAL for line scan cameras
AOI_Width	AOI width
AOI_Height	AOI height

◆ ConfigureCLInput() [3/3]

void VIB_NET::CameraLinkIn::ConfigureCLInput	(	const UInt32	ChannelIndex,
		const CameraLinkIn::eINMODE_TYPE	InType,
		const CameraLinkIn::eINMODE_FLAGS	InFlags,
		const UInt32	AOI_Width,
		const UInt32	AOI_Height,
		const UInt32	AOI_X,
		const UInt32	AOI_Y
	)

Configures a camera channel

To reconfigure the channel, after the first call, the complete device has to be closed and opened again.

Parameters

ChannelIndex	Camera index, 0 ... GetNumberOfInputs()
InType	Define the desired Pixel/Data or streaming format
InFlags	Bitwise OR of configuration flags defined in eINMODE_FLAGS Use eINMODE_FLAGS::FLAGS_DEFAULT for area scan cameras and eINMODE_FLAGS::FLAGS_IGNORE_FVAL for line scan cameras
AOI_Width	AOI width
AOI_Height	AOI height
AOI_X	Horizontal start position
AOI_Y	Vertical start position

◆ ConfigureModule()

void VIB_NET::CameraLinkIn::ConfigureModule ( const CameraLinkIn::eMODULE_CONFIGURATION ModuleConfig )

Configure the module to the given mode

This function can only be called once after the device was opened.

Parameters

ModuleConfig the new working mode for the whole module

◆ FreeImageBuffer()

void VIB_NET::CameraLinkIn::FreeImageBuffer	(	const UInt32	ChannelIndex,
		IntPtr	ptr
	)

Frees the specified buffer

It's only allowed to clean up buffers which is owned by the user. Use AbortBufferUsage() and WaitForImageBuffer() to gain ownership for buffers in the aquisition queue.

Parameters

ChannelIndex	Camera index, use GetNumberOfInputs() to find the maximum
ptr	Pointer to the image buffer

◆ GetAOI()

void VIB_NET::CameraLinkIn::GetAOI	(	const UInt32	ChannelIndex,
		UInt32 %	AOI_X,
		UInt32 %	AOI_Y,
		UInt32 %	AOI_Width,
		UInt32 %	AOI_Height
	)

Returns the configured AOI size.

The camera channel must be configured with ConfigureCLInput() before calling this function.

Parameters

ChannelIndex	Camera index, 0 ... GetNumberOfInputs()
AOI_X	Horizontal AOI start position
AOI_Y	Vertical AOI start position
AOI_Width	AOI width
AOI_Height	AOI height

◆ GetBitsPerPixel()

void VIB_NET::CameraLinkIn::GetBitsPerPixel	(	const UInt32	ChannelIndex,
		UInt32 %	ValidBits,
		UInt32 %	BufferBits
	)

Returns the number of bits for each pixel.

The camera channel must be configured with ConfigureCLInput() before calling this function.

Parameters

ChannelIndex	Camera index, 0 ... GetNumberOfInputs()
ValidBits	Number of usable bits per pixel
BufferBits	Number of bits per pixel used in the image buffers, including the unused padding bits

◆ GetBufferSize()

void VIB_NET::CameraLinkIn::GetBufferSize	(	const UInt32	ChannelIndex,
		UInt32 %	Bytes
	)

Returns the number of bytes allocated for each image buffer.

The camera channel must be configured with ConfigureCLInput() before calling this function.

Parameters

ChannelIndex	Camera index, 0 ... GetNumberOfInputs()
Bytes	Number of bytes

◆ GetNumberOfInputs()

UInt32 VIB_NET::CameraLinkIn::GetNumberOfInputs ( const CameraLinkIn::eMODULE_CONFIGURATION ModuleConfig )

Returns the number of independent Camera Link input channels

The number depends on hardware, firmware and the specified Camera Link configuration. The returned number can be 0 for 'not supported', 1 for one channel / camera and 2 for two cameras (Camera Link Base only).

Parameters

ModuleConfig Specifies the configuration for which the function returns the number of channels

Returns: Number of channels / cameras which can be connected

◆ Reset()

void VIB_NET::CameraLinkIn::Reset ( )

Resets the device to default settings.

◆ WaitForImageBuffer() [1/2]

IntPtr VIB_NET::CameraLinkIn::WaitForImageBuffer	(	const UInt32	ChannelIndex,
		const UInt32	msTimeOut,
		bool %	IsContentValid
	)

Waits for completion of image buffers and transfers ownership to the user

See overloaded version of this function with the additional timestamp parameter for details.

Parameters

ChannelIndex	Camera index, use GetNumberOfInputs() to find the maximum
msTimeOut	TimeOut in milliseconds, 0 ... `INFINITE`
IsContentValid	If the returned image buffer is valid, this flag indicates if the buffer contents are valid (acquisition was successful)

◆ WaitForImageBuffer() [2/2]

IntPtr VIB_NET::CameraLinkIn::WaitForImageBuffer	(	const UInt32	ChannelIndex,
		const UInt32	msTimeOut,
		bool %	IsContentValid,
		UInt64 %	timestamp
	)

Waits for completion of image buffers and transfers ownership to the user

Multiple threads can call this function simultaneously. The first caller returns first with the next completed buffer.

After successful return of the function, one of three events have occured:

The returned pointer is valid and IsContentValid is true:
The ownership of the buffer is transfered to the user and image acquisition was successful.
The returned pointer is valid and IsContentValid is false:
The ownership of the buffer is transfered to the user, but the image acquisition was not successful. The contens of the image buffer are not valid or only partially valid. The cause can be an incorrectly configured frame size and format, a problem with the Camera Link signals, or call of AbortBufferUsage().
The returned pointer is NULL:
The timeout expired or AbortWaitingForDMA() was called. Image buffers remain in the acquisition queue. After a timeout, the user can call this function again to check for ready images.

After a valid buffer was returned, it can be released with FreeImageBuffer() or added to the acquisition queue again with WaitForImageBuffer().

This function is also used to obtain buffers after AbortBufferUsage() was called.

Parameters

ChannelIndex	Camera index, use GetNumberOfInputs() to find the maximum
msTimeOut	TimeOut in milliseconds, 0 ... `INFINITE`
IsContentValid	If the returned image buffer is valid, this flag indicates if the buffer contents are valid (acquisition was successful)
timestamp	If the returned image buffer is valid, the timestamp value contains the point in time of the image transfer completion within the driver. The timestamp value is stored in micro-seconds and is based on the Windows performance counter (QueryPerformanceCounter()). The value will be zero if the driver doesn't support timestamps.

Returns: Pointer to the new image data or NULL-pointer if a timeout expired or AbortWaitingForDMA() was called

Property Documentation

◆ Type

VIB_NET::CameraLinkIn::Type

get

Returns the device type for the current instance, see eDEVICE_TYPE

ChannelIndex	Camera index, use GetNumberOfInputs() to find the maximum
CCIndex	Index for the CC-Line [1...4]
src	The desired source signal
Invert	Polarity of the output signal

Detailed Description

Public Types

Public Member Functions

Properties

Member Enumeration Documentation

◆ eCC_SOURCE

◆ eINMODE_FLAGS

◆ eINMODE_TYPE

◆ eMODULE_CONFIGURATION

Constructor & Destructor Documentation

◆ CameraLinkIn()

Member Function Documentation

◆ AbortBufferUsage()

◆ AbortWaitingForDMA()

◆ AddImageBufferForCapturing()

◆ AllocateImageBuffer()

◆ ConfigureCC()

◆ ConfigureCLInput() [1/3]

◆ ConfigureCLInput() [2/3]

◆ ConfigureCLInput() [3/3]

◆ ConfigureModule()

◆ FreeImageBuffer()

◆ GetAOI()

◆ GetBitsPerPixel()

◆ GetBufferSize()

◆ GetNumberOfInputs()

◆ Reset()

◆ WaitForImageBuffer() [1/2]

◆ WaitForImageBuffer() [2/2]

Property Documentation

◆ Type