Raytrix Light Field SDK  v3.1
Logo
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events Groups Pages
Main API functions

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

Functions

static void Rx::Net::ApiLF::RxDongleGetID (int% iDngID, int% iRxID)
 Get the IDs of an attached dongle. More...
 
static void Rx::Net::ApiLF::RxFinalize ()
 Close any open cameras and free all memory allocated on CUDA device and in host memory. More...
 
static double Rx::Net::ApiLF::RxGetLastExecTime ()
 Get last execution time of a CUDA algorithm. More...
 
static void Rx::Net::ApiLF::RxGetRegistryString (System::String^ sPath, System::String^ %sValue)
 Read a string from the Windows registry. More...
 
static System::DateTime Rx::Net::ApiLF::RxGetReleaseDate ()
 Gets the release date of this version of the Raytrix Light Field Runtime. Can be called without initializing the API. More...
 
static bool Rx::Net::ApiLF::RxHasFeature (unsigned uFeatureIDs)
 Test whether the Dongle offers the given features. More...
 
static bool Rx::Net::ApiLF::RxHasFeature (Rx::Net::ApiLF::RuntimeFeature eFeatureID)
 Test whether the Dongle offers a given feature. More...
 
static void Rx::Net::ApiLF::RxInit ()
 Initialize the Raytrix API. More...
 
static void Rx::Net::ApiLF::RxInit (System::String^ sLibPath, System::String^ sCalibPath)
 Initialize the Raytrix API. More...
 
static void Rx::Net::ApiLF::RxInit (bool bInitCuda, System::String^ sLibPath, System::String^ sCalibPath)
 Initialize the Raytrix API. More...
 

Detailed Description

Functions for fundamental API operations like initialization.

Function Documentation

static void Rx::Net::ApiLF::RxDongleGetID ( int%  iDngID,
int%  iRxID 
)
static

Get the IDs of an attached dongle.

Halcon Plugin - Function Name:
rx_dongle_get_id.
Parameters
[in]iDngIDOn return contains the hardware dongle ID.
[in]iRxIDOn return contains the Raytrix dongle ID.
static void Rx::Net::ApiLF::RxFinalize ( )
static

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.
static double Rx::Net::ApiLF::RxGetLastExecTime ( )
static

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.
static void Rx::Net::ApiLF::RxGetRegistryString ( System::String^  sPath,
System::String^ %  sValue 
)
static

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
[in]sPathThe registry path.
[out]sValueThe returned string value.
static System::DateTime Rx::Net::ApiLF::RxGetReleaseDate ( )
static

Gets the release date of this version of the Raytrix Light Field Runtime. Can be called without initializing the API.

Returns
The release date.
static bool Rx::Net::ApiLF::RxHasFeature ( unsigned  uFeatureIDs)
static

Test whether the Dongle offers the given features.

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::Net::ApiLF::RuntimeFeature. For example, to test for the features multiview and 3D evaluation call:
Halcon Plugin - Function Name:
rx_has_feature
Parameters
uFeatureIDsA OR-ed list of Rx::Net::ApiLF::RuntimeFeature to check for availability.
Returns
true if the feature is available, false otherwise.
static bool Rx::Net::ApiLF::RxHasFeature ( Rx::Net::ApiLF::RuntimeFeature  eFeatureID)
static

Test whether the Dongle offers a given 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.
Halcon Plugin - Function Name:
rx_has_feature
Parameters
eFeatureIDThe feature to check for availability.
Returns
true if the feature is available, false otherwise.
static void Rx::Net::ApiLF::RxInit ( )
static

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::Net::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::Net::ApiLF::RxCudaSelectDevice.To access Raytrix cameras you first have to callRx::Net::ApiLF::RxCamDriverInit and Rx::Net::ApiLF::RxCamRegister.
Halcon Plugin - Function Name:
rx_init.
static void Rx::Net::ApiLF::RxInit ( System::String^  sLibPath,
System::String^  sCalibPath 
)
static

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::Net::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::Net::ApiLF::RxCudaSelectDevice.To access Raytrix cameras you first have to callRx::Net::ApiLF::RxCamDriverInit and Rx::Net::ApiLF::RxCamRegister.
Parameters
[in]sLibPathIf set to false only functionality that does not rely on CUDA can be used.
[in]sCalibPathThe absolute path to the camera driver DLLs (RaytrixCamera_*.dll).
static void Rx::Net::ApiLF::RxInit ( bool  bInitCuda,
System::String^  sLibPath,
System::String^  sCalibPath 
)
static

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::Net::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::Net::ApiLF::RxCudaSelectDevice.To access Raytrix cameras you first have to callRx::Net::ApiLF::RxCamDriverInit and Rx::Net::ApiLF::RxCamRegister.
Parameters
bInitCudaIf set to false only functionality that does not rely on CUDA can be used.
[in]sLibPathThe absolute path to the camera driver DLLs (RaytrixCamera_*.dll).
[in]sCalibPathThe absolute path to the camera calibration directories.