Copyright (C) 2010 by Raytrix GmbH. All rights reserved.
This is the documentation of the Raytrix Lightfield API. It covers image capturing from Raytrix cameras, loading and saving of lightfield images in the .ray format, and processing of such lightfield images for refocussing, depth estimation and more. To use the Raytrix Lightfield API you need an appropriate dongle, which enables a certain set of features, depending on your licence. If you want to use the Raytrix LF API in a third party product, then please contact Raytrix (info@raytrix.de) for further details on licencing.
The API function reference can also be accessed by selecting the tab 'Modules' at the top of the page.
Before you install this software package ensure that you have the following software installed on your machine:
Your graphics card must support NVIDIA CUDA with computing capability 1.0 or higher. You need the latest display driver (at least v260.61).
The main environment variable that is installed is RX_PATH_APILF. It points to the top installation directory of RxLive. The installer also adds the path RX_PATH_APILF%\bin to the PATH environment variable of the system, so that the API LF DLLs are found automatically. The following paths are needed for building a project:
RX_PATH_APILF\SDK\include: The include path. The Raytrix headers are in the subdirectory Raytrix.
RX_PATH_APILF\SDK\lib\Win32: The library path for linking the 32 bit version of RxApiLF.dll. A 64 bit version does not exist, yet. However, the 32bit version also runs on 64 bit systems. The example Visual Studio 2008 projects included with the API are located in RX_PATH_APILF\SDK\Examples. Before you can compile these examples you need to copy them to a directory where you have write access. The source code of these examples is also included in this documentation. You can browse the example code by clicking on the "Examples" tab at the top of the page.
The available examples are:
Basic Example 1
This basic example demonstrates the minimal set of function calls to initialize the API, load a ray image, refocus it and read it from the CUDA device.
Basic Example 2
In addition to the basic Raytrix API functionality, this example shows how the CLUVizTool library can be used to display and save images.
Progress Example 1
This example demonstrates how to display the progress of the depth evaluation by deriving a class from IProgress and registering it with the API using RxRegisterProgressIfc().
Camera Example 1
This example demonstrated how to work with Raytrix cameras. It shows how to select a camera and open it, select a calibration setting and how to capture images.
