Functions for fundamental API operations like initialization. More...

Functions
RXLF_API void	Rx::ApiLF::RxDongleGetID (int &iDngID, int &iRxID)
	Get the IDs of an attached dongle. More...

RXLF_API void	Rx::ApiLF::RxDongleReinitialize ()
	Raytrix dongle reinitialize. More...

RXLF_API void	Rx::ApiLF::RxFinalize (void)
	Close any open cameras and free all memory allocated on CUDA device and in host memory. More...

RXLF_API double	Rx::ApiLF::RxGetLastExecTime ()
	Get last execution time of a CUDA algorithm. More...

RXLF_API void	Rx::ApiLF::RxGetRegistryString (const Rx::CRxString &sxPath, Rx::CRxString &sxValue)
	Read a string from the Windows registry. More...

RXLF_API bool	Rx::ApiLF::RxHasFeature (unsigned uID)
	Test whether the Dongle offers a particular feature. More...

RXLF_API void	Rx::ApiLF::RxInit (bool bInitCuda, const Rx::CRxString &sxLibPath=Rx::CRxString(), const Rx::CRxString &sxCalibPath=Rx::CRxString(), void *pData=0)
	Initialize the Raytrix API. More...

RXLF_API void	Rx::ApiLF::RxInit (const Rx::CRxString &sxLibPath=Rx::CRxString(), const Rx::CRxString &sxCalibPath=Rx::CRxString(), void *pData=0)
	Initialize the Raytrix API. More...

RXLF_API void	Rx::ApiLF::RxInit (bool bInitCuda=true, void *pData=0)
	Initialize the Raytrix API. More...

Detailed Description

Functions for fundamental API operations like initialization.

Function Documentation

RXLF_API void Rx::ApiLF::RxDongleGetID	(	int &	iDngID,
		int &	iRxID
	)

Get the IDs of an attached dongle.

Halcon Plugin - Function Name:: rx_dongle_get_id.

Parameters

[in]	iDngID	On return contains the hardware dongle ID.
[in]	iRxID	On return contains the Raytrix dongle ID.

RXLF_API void Rx::ApiLF::RxDongleReinitialize ( )

Raytrix dongle reinitialize.

RXLF_API void Rx::ApiLF::RxFinalize ( void )

Close any open cameras and free all memory allocated on CUDA device and in host memory.

Warning: Make sure to call this function before ending your program. Otherwise the CUDA device memory will fill up with repeated execution of the software.

Halcon Plugin - Function Name:: rx_finalize.

RXLF_API double Rx::ApiLF::RxGetLastExecTime ( )

Get last execution time of a CUDA algorithm.

Attention: The time returned here is the pure calculation time on the CUDA device without data transfer between host and device or any time used on host before and after the actual CUDA kernel call.

Returns: The last execution time of a CUDA kernel in milliseconds.

RXLF_API void Rx::ApiLF::RxGetRegistryString	(	const Rx::CRxString &	sxPath,
		Rx::CRxString &	sxValue
	)

Read a string from the Windows registry.

Attention: The registry path has to start with HKLM\ .A registry path must have the following structure HKLM\[path to key]\[value name]:[relative path] . The last colon and the relative path are optional.For example, if the registry value with path HKLM\SOFTWARE\Raytrix\RxLive\Install_Dir contains the value C:\Program Files(x86)\Raytrix\RxLive, then setting sxPath to HKLM\SOFTWARE\Raytrix\RxLive\Install_Dir:bin is translated into the library path C:\Program Files(x86)\Raytrix\RxLive\bin.

Parameters

	sxPath	The registry path.
[out]	sxValue	The returned string value.

RXLF_API bool Rx::ApiLF::RxHasFeature ( unsigned uID )

Test whether the Dongle offers a particular feature.

Attention: Not all functions of this API are necessarily available. This depends on the currently active license, which is defined by the Raytrix dongle attached to the system. To check whether a set of features is available you can OR the corresponding feature IDs. The feature IDs are available through defines all starting with Rx::ApiLF::Rx_Dongle_RuntimeFeature. For example, to test for the features multiview and 3D evaluation call:
if(Rx::ApiLF::RxHasFeature(Rx::Dongle::RuntimeFeature::MultiView | Rx::Dongle::RuntimeFeature::Calculate3D)){...}

Halcon Plugin - Function Name:: rx_has_feature

Parameters

uID	The identifier.

Returns: true if the feature is available, false otherwise.

RXLF_API void Rx::ApiLF::RxInit	(	bool	bInitCuda,
		const Rx::CRxString &	sxLibPath = `Rx::CRxString()`,
		const Rx::CRxString &	sxCalibPath = `Rx::CRxString()`,
		void *	pData = `0`
	)

Initialize the Raytrix API.

This function has to be called before any other API function, with the exception of

If the parameters sxLibPath and sxCalibPath are not specified, the default paths that were given during installation are read from the registry.They are stored under the registry key: HKLM\SOFTWARE\Raytrix\RxLive To specify different paths, these either have to be absolute paths with a drive letter and a colon(':') as the first two characters, or a registry path.A registry path must have the following structure:HKLM[pathtokey]\[value name]:[relative path] The last colon and the relative path are optional. For example, if the registry value with path: HKLM\SOFTWARE\Raytrix\RxLive\Install_Dir contains the value: C:\Program Files(x86)\Raytrix\RxLive, then setting sxLibPath to HKLM\SOFTWARE\Raytrix\RxLive\Install_Dir:bin is translated into the library path: C:\ProgramFiles(x86)\Raytrix\RxLive\bin

Attention: After executing Rx::ApiLF::RxInit neither a CUDA device is selected nor a camera device initialized.

Precondition: Before any light field images can be loaded, recorded or processed a CUDA device has to be chosen using the function Rx::ApiLF::RxCudaSelectDevice.To access Raytrix cameras you first have to call Rx::ApiLF::RxCamDriverInit and Rx::ApiLF::RxCamRegister.

Halcon Plugin - Function Name:: rx_init

Parameters

	bInitCuda	If set to false only functionality that does not rely on CUDA can be used.
	sxLibPath	(Optional) The absolute path to the camera driver DLLs (RaytrixCamera_*.dll).
	sxCalibPath	(Optional) The absolute path to the camera calibration directories.
[in]	pData	(Optional) Reserved. Must be zero.

RXLF_API void Rx::ApiLF::RxInit	(	const Rx::CRxString &	sxLibPath = `Rx::CRxString()`,
		const Rx::CRxString &	sxCalibPath = `Rx::CRxString()`,
		void *	pData = `0`
	)

Initialize the Raytrix API.

This function has to be called before any other API function, with the exception of

If the parameters sxLibPath and sxCalibPath are not specified, the default paths that were given during installation are read from the registry.They are stored under the registry key: HKLM\SOFTWARE\Raytrix\RxLive To specify different paths, these either have to be absolute paths with a drive letter and a colon(':') as the first two characters, or a registry path.A registry path must have the following structure:HKLM[pathtokey]\[value name]:[relative path] The last colon and the relative path are optional. For example, if the registry value with path: HKLM\SOFTWARE\Raytrix\RxLive\Install_Dir contains the value: C:\Program Files(x86)\Raytrix\RxLive, then setting sxLibPath to HKLM\SOFTWARE\Raytrix\RxLive\Install_Dir:bin is translated into the library path: C:\ProgramFiles(x86)\Raytrix\RxLive\bin

Attention: After executing Rx::ApiLF::RxInit neither a CUDA device is selected nor a camera device initialized.

Precondition: Before any light field images can be loaded, recorded or processed a CUDA device has to be chosen using the function Rx::ApiLF::RxCudaSelectDevice.To access Raytrix cameras you first have to call Rx::ApiLF::RxCamDriverInit and Rx::ApiLF::RxCamRegister.

Halcon Plugin - Function Name:: rx_init

Parameters

	sxLibPath	(Optional) The absolute path to the camera driver DLLs (RaytrixCamera_*.dll).
	sxCalibPath	(Optional) The absolute path to the camera calibration directories.
[in]	pData	(Optional) Reserved. Must be zero.

RXLF_API void Rx::ApiLF::RxInit	(	bool	bInitCuda = `true`,
		void *	pData = `0`
	)

Initialize the Raytrix API.

This function has to be called before any other API function, with the exception of

If the parameters sxLibPath and sxCalibPath are not specified, the default paths that were given during installation are read from the registry.They are stored under the registry key: HKLM\SOFTWARE\Raytrix\RxLive To specify different paths, these either have to be absolute paths with a drive letter and a colon(':') as the first two characters, or a registry path.A registry path must have the following structure:HKLM[pathtokey]\[value name]:[relative path] The last colon and the relative path are optional. For example, if the registry value with path: HKLM\SOFTWARE\Raytrix\RxLive\Install_Dir contains the value: C:\Program Files(x86)\Raytrix\RxLive, then setting sxLibPath to HKLM\SOFTWARE\Raytrix\RxLive\Install_Dir:bin is translated into the library path: C:\ProgramFiles(x86)\Raytrix\RxLive\bin

Attention: After executing Rx::ApiLF::RxInit neither a CUDA device is selected nor a camera device initialized.

Precondition: Before any light field images can be loaded, recorded or processed a CUDA device has to be chosen using the function Rx::ApiLF::RxCudaSelectDevice.To access Raytrix cameras you first have to call Rx::ApiLF::RxCamDriverInit and Rx::ApiLF::RxCamRegister.

Halcon Plugin - Function Name:: rx_init

Parameters

	bInitCuda	(Optional) true to initialise CUDA.
[in]	pData	(Optional) If non-null, the data.