ApiLF.
Static Public Member Functions | |
static void * | GetInterface (Interfaces::EApiLF::ID eInterface) |
Gets the interface defined by the given interface ID. More... | |
static void | RxAddStatusMessageHandler (Rx::LFR::TFuncStatusMsg pFunc, void *pvContext) |
Registers a status message callback Function. This function will be called when a new Status Message is fired. More... | |
static void | RxCalibDBAssignGrayImageToBoundCalib (const Rx::CRxString &sxGUID, bool bLoadGrayImg) |
Assign the gray image of the calibration with the given GUID to the bound calibration. This copies the gray image. More... | |
static void | RxCalibDBBindCalib (const Rx::CRxString &sxGUID, bool bApplyGrayImage) |
Applies the camera calibration defined by GUID sxGUID to the currently bound image in API. Also updates the computational class. More... | |
static void | RxCalibDBBindCalibGrayImage (unsigned &uRayHandle, const Rx::CRxString &sxGUID) |
Bind gray image of calibration to API and use this image as gray image too. Now you can calibrate a calibration without using a camera. More... | |
static void | RxCalibDBBoundCameraNewCalib (Rx::CRxString &sxNewGUID) |
Creates a new calibration and returns the GUID of the newly created calibration in sxNewGUID. More... | |
static void | RxCalibDBCameraNewCalib (Rx::CRxString &sxNewGUID, unsigned uCamIdx) |
Creates a new calibration and returns the GUID of the newly created calibration in sxNewGUID. More... | |
static void | RxCalibDBCreateDataBase (const Rx::CRxString &sxCamHardwareId, bool bForce) |
Creates a new calibration database for camera with name sxCamHardwareId. More... | |
static void | RxCalibDBCreateDataBaseForBoundCamera (bool bForce) |
Creates a new calibration database for bound camera. More... | |
static void | RxCalibDBCreateDataBaseForCamera (unsigned uCamIdx, bool bForce) |
Creates a new calibration database for camera with ID uCamIdx More... | |
static void | RxCalibDBDeleteCalib (const Rx::CRxString &sxGUID) |
Deletes camera calibration with GUID sxGUID More... | |
static void | RxCalibDBGetCameraCalibGuidList (Rx::CRxArrayString &asxGUIDs, unsigned uCamIdx) |
Gets a Rx::CRxArrayString which contains unique IDs of all calibration for camera with given index uCamIdx. More... | |
static void | RxCalibDBGetCameraMasterCalibGuid (Rx::CRxString &sxGUID, unsigned uCamIdx) |
Gets a Rx::CRxString which contains the GUID of the master calibration of this camera. More... | |
static void | RxCalibDBGetCompleteCalibGuidList (Rx::CRxArrayString &asxGUIDs) |
Gets a Rx::CRxArrayString which contains GUIDs of all calibration on this computer. More... | |
static void | RxCalibDBGetCompleteMasterCalibGuidList (Rx::CRxArrayString &asxGUIDs) |
Gets a Rx::CRxArrayString which contains GUIDs of all master calibration on this computer. More... | |
static void | RxCalibDBLoadBoundCalibMetaData (Rx::CRxCalibMetaData &xCalibData) |
Gets the last applied calibration data. More... | |
static void | RxCalibDBLoadCalibMetaData (Rx::CRxCalibMetaData &xCalibData, const Rx::CRxString &sxGUID) |
Gets Rx::CRxCalibMetaData for calibration with given GUID sxGUID. More... | |
static void | RxCalibDBNewCalib (Rx::CRxString &sxNewGUID, const Rx::CRxString &sxCamHardwareId) |
Creates a new calibration and returns the GUID of the newly created calibration in sxNewGUID. More... | |
static void | RxCalibDBReloadBoundCalib (bool bApplyGrayImage) |
Applies the currently bound camera calibration to the current bound image in API. Also updates to the computational class. More... | |
static void | RxCalibDBSaveBoundCalibMetaData (const Rx::CRxCalibMetaData &xCalibData) |
Sets calibration data to the last applied calibration. More... | |
static void | RxCalibDBSaveCalibMetaData (const Rx::CRxCalibMetaData &xCalibData, const Rx::CRxString &sxGUID) |
Sets Rx::CRxCalibMetaData for calibration with given GUID sxGUID. More... | |
static void | RxCalibDBUpdateAndSaveBoundCalib () |
Gets calibration (The camera calibration) from current bound image and saves it to current calibration. Also saves database to disk. More... | |
static void | RxCalibDBUpdateAndSaveCalib (const Rx::CRxString &sxGUID) |
Gets (The camera calibration) from current bound image and saves it to the calibration defined by GUID sxGUID Also saves database to disk. More... | |
static unsigned | RxCamBind (unsigned uCamIdx) |
Binds the given camera to the returned API image ID. Call RxCamUnBind to unbind the bound camera. Only one camera can be bound. Calling Rx::LFR::CApiLF::RxCamBind with another camera index results in an Rx::CRxException. More... | |
static void | RxCamClose (unsigned uCamIdx) |
Closes the given camera. If the given camera is currently bound, the camera is unbound before closing. Also, if the camera is in capture mode, the capturing is stopped before unbinding. More... | |
static void | RxCamGetPar (unsigned uCamIdx, Rx::Interop::Runtime30::Camera::EProperty::ID ePar, Rx::CRxString &sxValue) |
Get a camera parameter of type Rx::CRxString. More... | |
static void | RxCamGetPar (unsigned uCamIdx, Rx::Interop::Runtime30::Camera::EProperty::ID ePar, unsigned &uValue) |
Get a camera parameter of type unsigned integer. More... | |
static void | RxCamGetPar (unsigned uCamIdx, Rx::Interop::Runtime30::Camera::EProperty::ID ePar, double &dValue) |
Get camera parameter of type double More... | |
static void | RxCamGetPar (unsigned uCamIdx, Rx::Interop::Runtime30::Camera::EProperty::ID ePar, Rx::CRxArrayString &aValue) |
Get camera parameter of type Rx::CRxArrayString. More... | |
static void | RxCamGetPar (Rx::Interop::Runtime30::Camera::EProperty::ID ePar, Rx::CRxString &sxValue) |
Get a camera parameter of type Rx::CRxString from the currently bound camera. More... | |
static void | RxCamGetPar (Rx::Interop::Runtime30::Camera::EProperty::ID ePar, unsigned &uValue) |
Get a camera parameter of type unsigned integer from the currently bound camera. More... | |
static void | RxCamGetPar (Rx::Interop::Runtime30::Camera::EProperty::ID ePar, double &dValue) |
Get camera parameter of type double from the currently bound camera. More... | |
static void | RxCamGetPar (Rx::Interop::Runtime30::Camera::EProperty::ID ePar, Rx::CRxArrayString &aValue) |
Get camera parameter of type Rx::CRxArrayString. More... | |
static void | RxCamGetParRange (unsigned uCamIdx, Rx::Interop::Runtime30::Camera::EProperty::ID ePar, unsigned &uMin, unsigned &uMax) |
Get the parameter range of a camera parameter of type unsigned integer. More... | |
static void | RxCamGetParRange (unsigned uCamIdx, Rx::Interop::Runtime30::Camera::EProperty::ID ePar, double &dMin, double &dMax) |
Get the parameter range of a camera parameter of type double More... | |
static void | RxCamGetParRange (unsigned uCamIdx, Rx::Interop::Runtime30::Camera::EProperty::ID ePar, Rx::CRxArrayUInt &auValues) |
Get a set of available values for a parameter of type unsigned integer More... | |
static void | RxCamGetParRange (Rx::Interop::Runtime30::Camera::EProperty::ID ePar, unsigned &uMin, unsigned &uMax) |
Get the parameter range of a camera parameter of type unsigned integer from the currently bound camera. More... | |
static void | RxCamGetParRange (Rx::Interop::Runtime30::Camera::EProperty::ID ePar, double &dMin, double &dMax) |
Get the parameter range of a camera parameter of type double from the currently bound camera. More... | |
static void | RxCamGetParRange (Rx::Interop::Runtime30::Camera::EProperty::ID ePar, Rx::CRxArrayUInt &auValues) |
Get set of available values for parameter of type unsigned. More... | |
static bool | RxCamIsParameterSupported (Rx::Interop::Runtime30::Camera::EProperty::ID ePar, unsigned uCamIdx) |
Test whether a camera parameter is supported by the given camera. More... | |
static bool | RxCamIsParameterSupported (Rx::Interop::Runtime30::Camera::EProperty::ID ePar) |
Test whether a camera parameter is supported by the currently bound camera. More... | |
static void | RxCamOpen (unsigned uCamIdx) |
Opens the given camera. Camera settings can only be accessed after a camera has been opened. The first call to open initializes the camera too. More... | |
static void | RxCamRegister () |
Register available cameras. More... | |
static void | RxCamRegisterImageCallback (Rx::LFR::TFuncImageCaptured pFunc, void *pvContext) |
Register a callback function which is called when a new image is available. More... | |
static void | RxCamRemoveImageCallback () |
Remove the image callback function. More... | |
static bool | RxCamRetrieveImage () |
Retrieve a single image from the currently bound camera. More... | |
static void | RxCamSetPar (unsigned uCamIdx, Rx::Interop::Runtime30::Camera::EProperty::ID ePar, const Rx::CRxString &sxValue) |
Set a camera property of type Rx::CRxString. More... | |
static void | RxCamSetPar (unsigned uCamIdx, Rx::Interop::Runtime30::Camera::EProperty::ID ePar, unsigned uValue) |
Set a camera property of type unsigned integer. More... | |
static void | RxCamSetPar (unsigned uCamIdx, Rx::Interop::Runtime30::Camera::EProperty::ID ePar, double dValue) |
Set a camera property of type double. More... | |
static void | RxCamSetPar (Rx::Interop::Runtime30::Camera::EProperty::ID ePar, const Rx::CRxString &sxValue) |
Set a camera property of type Rx::CRxString from the currently bound camera. More... | |
static void | RxCamSetPar (Rx::Interop::Runtime30::Camera::EProperty::ID ePar, unsigned uValue) |
Set a camera property of type unsigned integer from the currently bound camera. More... | |
static void | RxCamSetPar (Rx::Interop::Runtime30::Camera::EProperty::ID ePar, double dValue) |
Set a camera property of type double More... | |
static void | RxCamStartCapture () |
Prepares the currently bound camera for capturing images. If the currently bound camera is already in capture mode, then the function throws an exception. More... | |
static void | RxCamStopCapture () |
Stops capturing of the currently bound camera. If the camera is not in capture mode, the function simply returns without error. More... | |
static void | RxCamSuspendCapture (bool bSuspend) |
Suspend capturing images. More... | |
static void | RxCamTrigger () |
Triggers capturing of a single image of the currently bound camera. The image can be retrieved by calling Rx::LFR::CApiLF::RxCamRetrieveImage. More... | |
static void | RxCamUnbind () |
Unbinds a currently bound camera. If the bound camera is still capturing images, the capturing is stopped and then the camera is unbound. More... | |
static void | RxConvertImage (Rx::CRxImage &xDstImage, const Rx::CRxImage &xSrcImage, Rx::Interop::Runtime28::EPixelType::ID eDstPixelType, Rx::Interop::Runtime28::EDataType::ID eDstDataType) |
Convert a Rx::CRxImage to a new pixel and data type. More... | |
static void | RxConvertImage (Rx::Interop::Runtime28::IImage *pDstImage, const Rx::Interop::Runtime28::IImage *pSrcImage, Rx::Interop::Runtime28::EPixelType::ID eDstPixelType, Rx::Interop::Runtime28::EDataType::ID eDstDataType, bool bCreate) |
Convert a Rx::CRxImage to a new pixel and data type. More... | |
static int | RxCudaDeviceCount () |
Returns the number of CUDA devices installed. More... | |
static void | RxCudaDeviceMemInfo (size_t &nFreeMem, size_t &nTotalMem) |
Return free and total amount of memory on the selected CUDA device. More... | |
static void | RxCudaDeviceProp (int iDevice, Rx::CRxString &sxName, unsigned &iCCMajor, unsigned &iCCMinor) |
Get the name and the compute capability major and minor version for a CUDA device. More... | |
static void | RxCudaSelectDevice (int iDevice=-1, bool bUseGL=false) |
Select a CUDA device. More... | |
static void | RxDepth3D () |
Object space depth 3D. More... | |
static void | RxDepthColorCode (Rx::LF::ESpace::ID eSpace) |
Colorizes the depth map created by Rx::LFR::CApiLF::RxDepthMap.The result is stored in the image with the ID LFR::EImage::Depth3D. More... | |
static void | RxDepthMap (Rx::LF::ESpace::ID eSpace) |
Creates a depth map from the ray depth image created by Rx::LFR::CApiLF::RxDepthRay. More... | |
static void | RxDepthRay () |
Estimates the depth of the bound ray image and stores the result in the image with the ID LFR::EImage::DepthRay. More... | |
static void | RxDongleGetID (int &iDngID, int &iRxID) |
Get the IDs of an attached dongle. More... | |
static void | RxFinalize () |
Close any open cameras and free all memory allocated on CUDA device and in host memory. More... | |
static void | RxFreeImage (LFR::EImage::ID eImgID) |
Frees memory used by the image defined in eImgID . This invalidates the image. More... | |
static void | RxGetImage (LFR::EImage::ID eImgID, Rx::CRxImage &xImage) |
Get an internal image. More... | |
static void | RxGetImage (LFR::EImage::ID eImgID, Rx::Interop::Runtime28::IImage *pImage, bool bCreate) |
Get an internal image. More... | |
static void | RxGetImageDevicePointer (LFR::EImage::ID eImgID, void *&pDevicePtr) |
Get the device pointer of an internal image. More... | |
static size_t | RxGetImageDevicePointerPitch (LFR::EImage::ID eImgID) |
Gets device pointer pitch, which is the width in bytes of the allocation. Given a row and column of an array element of type T, the address is computed as: More... | |
static void | RxGetImageFormat (LFR::EImage::ID eImgID, Rx::CRxImageFormat &xF) |
Get the image format of an internal image. More... | |
static void | RxGetImageHistogram (LFR::EImage::ID eImgID, Rx::CRxArrayUInt &xHistogram, unsigned &uChannels) |
Calculates the histogram of the image with the given eImgID and stores the histogram data in the given array. This array must be large enough to hold 4 * 256 numbers. The number of calculated channels is returned in uChannels. More... | |
static void | RxGetImageMinMax (LFR::EImage::ID eImgID, unsigned uChannel, float &fMin, float &fMax) |
Finds the minimum and maximum value of the given eImgID More... | |
static void | RxGetPar (Rx::LFR::Params::EApiLF::ID ePar, unsigned &uValue) |
Gets the value of a parameter. More... | |
static void | RxGetPar (Rx::LFR::Params::ECudaCompute::ID ePar, unsigned &uValue) |
Gets the value of a parameter. More... | |
static void | RxGetPar (Rx::LFR::Params::ECudaCompute::ID ePar, double &dValue) |
Gets the value of a parameter. More... | |
static void | RxGetPar (Rx::LFR::Params::ECudaCompute::ID ePar, Rx::CRxString &sValue) |
Gets the value of a parameter. More... | |
static void | RxGetPar (Rx::LFR::Params::ECudaCompute::ID ePar, Rx::CRxArrayUInt &auValue) |
Gets the value of a parameter. More... | |
static void | RxGetPar (Rx::LFR::Params::ECudaCompute::ID ePar, Rx::CRxArrayDouble &adValue) |
Gets the value of a parameter. More... | |
static void | RxGetPar (Rx::LFR::Params::ECudaCompute::ID ePar, Rx::CRxArrayString &asValue) |
Gets the value of a parameter. More... | |
static void | RxGetPar (Rx::LFR::Params::ECalib::ID ePar, unsigned &uValue) |
Gets the value of a parameter. More... | |
static void | RxGetPar (Rx::LFR::Params::ECalib::ID ePar, double &dValue) |
Gets the value of a parameter. More... | |
static void | RxGetPar (Rx::LFR::Params::ECalib::ID ePar, Rx::CRxString &sValue) |
Gets the value of a parameter. More... | |
static void | RxGetPar (Rx::LFR::Params::ECalib::ID ePar, Rx::CRxArrayUInt &auValue) |
Gets the value of a parameter. More... | |
static void | RxGetPar (Rx::LFR::Params::ECalib::ID ePar, Rx::CRxArrayDouble &adValue) |
Gets the value of a parameter. More... | |
static void | RxGetPar (Rx::LFR::Params::ECalib::ID ePar, Rx::CRxArrayString &asValue) |
Gets the value of a parameter. More... | |
static void | RxGetParName (Rx::LFR::Params::EApiLF::ID ePar, Rx::CRxString &sValue) |
Get the string representation of a parameter. More... | |
static void | RxGetParName (Rx::LFR::Params::ECudaCompute::ID ePar, Rx::CRxString &sValue) |
Get the string representation of a parameter. More... | |
static void | RxGetParName (Rx::LFR::Params::ECalib::ID ePar, Rx::CRxString &sValue) |
Get the string representation of a parameter. More... | |
static void | RxGetParProperties (Rx::LFR::Params::EApiLF::ID ePar, Rx::CRxString &sValue, bool &bReadAccess, bool &bWriteAccess, EValueType::ID &eParameterType) |
Get the Properties of a parameter. More... | |
static void | RxGetParProperties (Rx::LFR::Params::ECudaCompute::ID ePar, Rx::CRxString &sValue, bool &bReadAccess, bool &bWriteAccess, EValueType::ID &eParameterType) |
Get the Properties of a parameter. More... | |
static void | RxGetParProperties (Rx::LFR::Params::ECalib::ID ePar, Rx::CRxString &sValue, bool &bReadAccess, bool &bWriteAccess, EValueType::ID &eParameterType) |
Get the Properties of a parameter. More... | |
static void | RxGetParRange (Rx::LFR::Params::EApiLF::ID ePar, unsigned &uMin, unsigned &uMax) |
Get the value range of a parameter. More... | |
static void | RxGetParRange (Rx::LFR::Params::ECudaCompute::ID ePar, unsigned &uMin, unsigned &uMax) |
Get the value range of a parameter. More... | |
static void | RxGetParRange (Rx::LFR::Params::ECudaCompute::ID ePar, double &dMin, double &dMax) |
Get the value range of a parameter. More... | |
static void | RxGetParRange (Rx::LFR::Params::ECudaCompute::ID ePar, size_t &iMinCount, size_t &iMaxCount, unsigned &uMin, unsigned &uMax) |
Get the value range of an array parameter and the min and max allowed number of elements in the array. More... | |
static void | RxGetParRange (Rx::LFR::Params::ECudaCompute::ID ePar, size_t &iMinCount, size_t &iMaxCount, double &dMin, double &dMax) |
Get the value range of an array parameter and the min and max allowed number of elements in the array. More... | |
static void | RxGetParRange (Rx::LFR::Params::ECalib::ID ePar, unsigned &uMin, unsigned &uMax) |
Get the value range of a parameter. More... | |
static void | RxGetParRange (Rx::LFR::Params::ECalib::ID ePar, double &dMin, double &dMax) |
Get the value range of a parameter. More... | |
static void | RxGetParRange (Rx::LFR::Params::ECalib::ID ePar, size_t &iMinCount, size_t &iMaxCount, unsigned &uMin, unsigned &uMax) |
Get the value range of an array parameter and the min and max allowed number of elements in the array. More... | |
static void | RxGetParRange (Rx::LFR::Params::ECalib::ID ePar, size_t &iMinCount, size_t &iMaxCount, double &dMin, double &dMax) |
Get the value range of an array parameter and the min and max allowed number of elements in the array. More... | |
static void | RxGetReleaseDate (int &iDay, int &iMonth, int &iYear) |
Gets the release date of this version of the Raytrix Light Field Runtime. Can be called without initializing the API. More... | |
static void | RxGlGetContext () |
Assigns the OpenGL context created by Rx::LFR::CApiLF::RxCudaSelectDevice to the calling thread. More... | |
static void | RxGlGetTextureID (LFR::EImage::ID eImgID, unsigned &uGlTextureID) |
Get the OpenGL texture ID corresponding to given parameter eImgID The content of this texture can be updated with the Rx::LFR::CApiLF::RxGlUpdateTex function. More... | |
static unsigned | RxGlGetTextureID (LFR::EImage::ID eImgID) |
Get the OpenGL texture ID corresponding to given parameter eImgID The content of this texture can be updated with the Rx::LFR::CApiLF::RxGlUpdateTex function. More... | |
static void | RxGlGetVersion (int &iMajor, int &iMinor) |
Get OpenGL version of current OpenGL rendering context. More... | |
static void | RxGlReleaseContext () |
Releases the OpenGL context owned by the calling thread. More... | |
static void | RxGlSetContext () |
Store the threads current OpenGL context. The context can be retrieved with RxGlGetContext() and released with RxGlReleaseContext. More... | |
static void | RxGlUpdateTex (unsigned uIntImgIDs, bool bCreateMipmaps=false) |
Copy CUDA result images to OpenGL textures. More... | |
static void | RxGrid () |
Show a lens grid overlay on the raw ray image. More... | |
static bool | RxGridCalibrateMaster () |
Automatically calibrates the MLA rotation steps and the MLA reflection. Requires master dongle feature. More... | |
static bool | RxGridCalibrateMla () |
Automatically calibrates MLA grid. Requires master dongle feature. More... | |
static bool | RxGridCalibrateMli () |
Automatically calibrates MLI grid. More... | |
static void | RxGridDataImage () |
Pre Process a ray image with a minimal Set of preprocessing parameter. More... | |
static void | RxGridEnableCalibrationCallback (bool bEnable) |
Enables or disables a callback during automatic grid calibration via RxGridCalibrateMli, RxGridCalibrateMla and RxGridCalibrateMaster. More... | |
static bool | RxHasFeature (unsigned uFeatureIDs) |
Test whether the Dongle offers the given features. More... | |
static bool | RxHasFeature (Rx::Dongle::ERuntimeFeature::ID eFeatureID) |
Test whether the Dongle offers a given feature. More... | |
static void | RxInit (bool bUseCUDA=true, const Rx::CRxString &sxLibPath="", const Rx::CRxString &sxCalibPath="", void *pvData=0) |
Initialize the Raytrix API. More... | |
static bool | RxIsImageValid (LFR::EImage::ID eImgID) |
Test whether an internal image is valid. More... | |
static void | RxLoadParameter (const Rx::CRxString &sxFilename) |
Loads all writable API parameter from file. Its mandatory to bind a light field image before. More... | |
static bool | RxLockCudaMutex (int iTimeout) |
Locks the CUDA Mutex. More... | |
static void | RxMultiview () |
Creates a multi view image and stores the result in the image with the ID LFR::EImage::Multiview_ViewCamera. More... | |
static void | RxPreProcess () |
Pre-Process a ray image. More... | |
static bool | RxProject (Rx::CRxArrayDouble &adTrgPoints, const Rx::CRxArrayDouble &adSrcPoints, LF::ESpace::ID eTrgSpace, LF::ESpace::ID eSrcSpace) |
Projects an array of points from the given source space into the given target space. More... | |
static double | RxProjectDepth (double dSrcDepth, LF::ESpace::ID eSrcSpace, bool bSrcVD, LF::ESpace::ID eTrgSpace, bool bTrgVD) |
Projects the given source depth value into the given target space. More... | |
static void | RxRayBind (unsigned uRayHandle) |
Bind a ray image to perform computations on. More... | |
static void | RxRayCalibSaveXML (unsigned uRayHandle, const Rx::CRxString &sxFilename) |
Save calibration data of ray image in XML format. More... | |
static void | RxRayCalibXmlGet (unsigned uRayHandle, Rx::CRxString &sxXml) |
Get the calibration data of the given ray image as XML string. More... | |
static void | RxRayDelete (unsigned uRayHandle) |
Delete the image with the given ID. More... | |
static const void * | RxRayGetCameraFormat () |
Gets the pointer to the internal camera format. More... | |
static void | RxRayGetFormat (unsigned uRayHandle, Rx::CRxImageFormat &xF) |
Get the image format of a ray image. More... | |
static unsigned | RxRayGetFrameID (unsigned uRayHandle) |
Gets the frame ID of the given light field image. Used when working with sequences or cameras. More... | |
static unsigned | RxRayGetFrameID () |
Gets the frame ID of the bound light field image. Used when working with sequences or cameras. More... | |
static void | RxRayGetMetaData (Rx::CRxMetaData &xMetaData, unsigned uImgID) |
Get meta data of a ray image. More... | |
static void | RxRayGetMetaData (Rx::CRxMetaData &xMetaData) |
Get the meta data of the bound ray image. More... | |
static void | RxRayGetRaw (unsigned uRayHandle, Rx::CRxImage &xRawImage) |
Get the ray image as Rx::CRxImage instance. More... | |
static void | RxRayGetRaw (unsigned uRayHandle, Rx::Interop::Runtime28::IImage *pRawImage, bool bCreate) |
Get the ray image. More... | |
static double | RxRayGetTimestap (unsigned uRayHandle) |
Gets the image timestamp of the given light field image. Is 0 if the image hasn't a valid timestamp. You can use this timestamp and the timestamp of another camera or sequence frame to determine the time between them. More... | |
static double | RxRayGetTimestap () |
Gets the image timestamp of the bound light field image. Is 0 if the image hasn't a valid timestamp. You can use this timestamp and the timestamp of another camera or sequence frame to determine the time between them. More... | |
static unsigned | RxRayLoad (const Rx::CRxString &sxFilename) |
Load a ray image. More... | |
static unsigned | RxRayNew (const Rx::CRxImageFormat &xF) |
Create a new ray image. More... | |
static void | RxRaySave (unsigned uRayHandle, const Rx::CRxString &sxFilename, bool bUpdateMetaData) |
Saves the given light field image to the given file. More... | |
static void | RxRaySave (const Rx::CRxString &sxFilename, bool bUpdateMetaData) |
Saves the bound light field image to the given file. More... | |
static unsigned | RxRaySeqBind (unsigned uRaySeqHandle) |
Bind a ray sequence for use by other API functions. More... | |
static unsigned | RxRaySeqClose (unsigned uRaySeqHandle) |
Close a ray sequence. More... | |
static unsigned | RxRaySeqGetDoubleShotMode (unsigned uRaySeqHandle) |
Get the doubleshot mode used when recording the given sequence. More... | |
static void | RxRaySeqGetFileSize (unsigned uRaySeqHandle, unsigned __int64 &uFileSize) |
Get the total file size of the ray sequence in bytes. More... | |
static unsigned | RxRaySeqGetFrameBufferUsedCount (unsigned uRaySeqHandle) |
Get number of frame buffers in use. More... | |
static unsigned | RxRaySeqGetFrameCount (unsigned uRaySeqHandle) |
Receive ray sequence frame count. More... | |
static unsigned | RxRaySeqGetFrameCount () |
Get number of frames in ray sequence that is currently bound in read mode. More... | |
static unsigned | RxRaySeqGetFrameIndex (unsigned uRaySeqHandle) |
Get current frame index of ray sequence. More... | |
static bool | RxRaySeqIsBound () |
Determines if a sequence is bound for reading to the API. More... | |
static void | RxRaySeqMoveFrameIndex (unsigned uRaySeqHandle, int iStep) |
Move the frame index relative to the current position in the ray sequence. More... | |
static unsigned | RxRaySeqOpen (const Rx::CRxString &sxFilename, unsigned uMode, unsigned uFrameBufferCount) |
Open a ray sequence. Depending on the mode a ray sequence can be opened for reading or writing. More... | |
static void | RxRaySeqRead () |
Read a frame from the currently bound ray sequence. More... | |
static void | RxRaySeqSetFrameIndex (unsigned uRaySeqHandle, unsigned uFrameIdx) |
Set the current frame index of ray sequence. More... | |
static void | RxRaySeqUnbind (unsigned uRaySeqHandle) |
Unbind a ray sequence. If a ray sequence in write mode is unbound, the currently bound ray image stays bound. No more images can be written to the ray sequence once it has been unbound, however, the ray sequence has not been closed. It can be bound again to write further ray images to it. More... | |
static void | RxRaySeqWrite () |
Write currently bound ray image to currently bound ray sequence. More... | |
static void | RxRaySetMetaData (unsigned uRayHandle, const Rx::CRxMetaData &xMetaData) |
Set meta data of a ray image. More... | |
static void | RxRayUnbind () |
Unbind the currently bound ray image. More... | |
static void | RxRefocusBasic () |
Focus image to a plane perpendicular to the optical axis, i.e. parallel to the image plane. More... | |
static void | RxRemoveComputationFilterMask () |
Removes the computation filter mask image set by Rx::LFR::CApiLF::RxSetComputationFilterMask. More... | |
static void | RxRemoveStatusMessageHandler (Rx::LFR::TFuncStatusMsg pFunc, void *pvContext) |
Removes a registered message callback function. More... | |
static void | RxResetParameters () |
Resets all parameters to their default value. More... | |
static void | RxResizeImage (Rx::Interop::Runtime28::IImage *xDstImage, Rx::Interop::Runtime28::IImage *xSrcImage, int iDivider) |
Resize an image. More... | |
static void | RxSaveDepth3dMesh (const Rx::CRxString &sxFilename, bool bUseVD, const double dMaxEdgeLength=-1.0) |
Saves the 3D mesh provided by image 'Depth3D' to binary STL format. This requires a valid image computed by Rx::LFR::CApiLF::RxDepth3D. Triangles with a depth-variation larger than 'dMaxEdgeLength' for at least one vertex pair are not added to the mesh. More... | |
static void | RxSaveDepth3dMesh (const Rx::CRxString &sxFilename, bool bUseVD, const double dMaxEdgeLength, const double dCropLeftPerc, const double dCropRightPerc, const double dCropTopPerc, const double dCropBottomPerc) |
Saves the 3D mesh provided by image 'Depth3D' to binary STL format. This requires a valid image computed by Rx::LFR::CApiLF::RxDepth3D. Triangles with a depth-variation larger than 'dMaxEdgeLength' for at least one vertex pair are not added to the mesh. More... | |
static void | RxSaveDepth3dPointList (const Rx::CRxString &sxFilename, bool bUseVD) |
Saves the depth values of the current Depth3D image to the given file as a point list. More... | |
static void | RxSaveDepth3dPointList (const Rx::CRxString &sxFilename, bool bUseVD, const double dCropLeftPerc, const double dCropRightPerc, const double dCropTopPerc, const double dCropBottomPerc) |
Saves the depth values of the current Depth3D image to the given file as a point list. More... | |
static void | RxSaveParameter (const Rx::CRxString &sxFilename) |
Saves all writable API parameter to file. Its mandatory to bind a light field image before. More... | |
static void | RxSetApplicationDetails (const Rx::CRxString &sxAppName, const Rx::CRxString &sxAppVersion) |
Sets details about the application that uses this runtime currently. Saving a ray file will write this details into the meta data of the file. More... | |
static void | RxSetComputationFilterMask (const Rx::CRxImage &xImage) |
Sets the computation filter mask image. More... | |
static void | RxSetComputationFilterMask (const Rx::CRxString &sxFilename) |
Sets the computation filter mask image. More... | |
static void | RxSetImage (LFR::EImage::ID eImgID, const Rx::CRxImage &xImage) |
Set an internal image. More... | |
static void | RxSetImage (LFR::EImage::ID eImgID, const Rx::Interop::Runtime28::IImage *pImage) |
Set an internal image. More... | |
static void | RxSetPar (Rx::LFR::Params::EApiLF::ID ePar, unsigned uValue) |
Sets the value of a parameter. More... | |
static void | RxSetPar (Rx::LFR::Params::ECudaCompute::ID ePar, unsigned uValue) |
Sets the value of a parameter. More... | |
static void | RxSetPar (Rx::LFR::Params::ECudaCompute::ID ePar, double dValue) |
Sets the value of a parameter. More... | |
static void | RxSetPar (Rx::LFR::Params::ECudaCompute::ID ePar, const Rx::CRxString &sValue) |
Sets the value of a parameter. More... | |
static void | RxSetPar (Rx::LFR::Params::ECudaCompute::ID ePar, const Rx::CRxArrayUInt &auValue) |
Sets the value of a parameter. More... | |
static void | RxSetPar (Rx::LFR::Params::ECudaCompute::ID ePar, const Rx::CRxArrayDouble &adValue) |
Sets the value of a parameter. More... | |
static void | RxSetPar (Rx::LFR::Params::ECudaCompute::ID ePar, const Rx::CRxArrayString &asValue) |
Sets the value of a parameter. More... | |
static void | RxSetPar (Rx::LFR::Params::ECalib::ID ePar, unsigned uValue) |
Sets the value of a parameter. More... | |
static void | RxSetPar (Rx::LFR::Params::ECalib::ID ePar, double dValue) |
Sets the value of a parameter. More... | |
static void | RxSetPar (Rx::LFR::Params::ECalib::ID ePar, const Rx::CRxString &sValue) |
Sets the value of a parameter. More... | |
static void | RxSetPar (Rx::LFR::Params::ECalib::ID ePar, const Rx::CRxArrayUInt &auValue) |
Sets the value of a parameter. More... | |
static void | RxSetPar (Rx::LFR::Params::ECalib::ID ePar, const Rx::CRxArrayDouble &adValue) |
Sets the value of a parameter. More... | |
static void | RxSetPar (Rx::LFR::Params::ECalib::ID ePar, const Rx::CRxArrayString &asValue) |
Sets the value of a parameter. More... | |
static void | RxTotalFocus (Rx::LF::ESpace::ID eSpace) |
Focus on a depth surface. More... | |
static void | RxUnlockCudaMutex () |
Unlocks the CUDA Mutex. More... | |
|
static |
Gets the interface defined by the given interface ID.
eInterface | The interface ID. |
|
static |
Registers a status message callback Function. This function will be called when a new Status Message is fired.
pFunc | The callback function. |
pvContext | [in] A Context Pointer which is forwarded to the callback function call. |
|
static |
Assign the gray image of the calibration with the given GUID to the bound calibration. This copies the gray image.
sxGUID | The unique identifier of the calibration with the gray image to copy. |
bLoadGrayImg | true to load gray image. |
|
static |
Applies the camera calibration defined by GUID sxGUID to the currently bound image in API. Also updates the computational class.
sxGUID | GUID of the calibration which should be applied to bound image. |
bApplyGrayImage | If true, the current gray image is replaced by the one from the given calibration. |
|
static |
Bind gray image of calibration to API and use this image as gray image too. Now you can calibrate a calibration without using a camera.
This function returns the image ID of the bound gray image in uRayHandle.
uRayHandle | [out] Image ID of the bound gray image. |
sxGUID | The GUID of the calibration. |
|
static |
Creates a new calibration and returns the GUID of the newly created calibration in sxNewGUID.
sxNewGUID | [in] Unique identifier for the new calibration. |
|
static |
Creates a new calibration and returns the GUID of the newly created calibration in sxNewGUID.
sxNewGUID | [in] Unique identifier for the new calibration. |
uCamIdx | [in] id of a camera. |
|
static |
Creates a new calibration database for camera with name sxCamHardwareId.
sxCamHardwareId | Type of the camera. |
bForce | Flags whether to overwrite an existing database or not. |
|
static |
Creates a new calibration database for bound camera.
If a calibration database for this camera already exists, a new one will only be created if bForce is true Otherwise a Rx::CRxException is thrown.
bForce | Flags whether to overwrite an existing database or not. |
|
static |
Creates a new calibration database for camera with ID uCamIdx
If a calibration database for this camera already exists, a new one will only be created if bForce is true. Otherwise a Rx::CRxException is thrown.
uCamIdx | Zero-based index of the camera. |
bForce | Flags whether to overwrite an existing database or not. |
|
static |
Deletes camera calibration with GUID sxGUID
sxGUID | The GUID of the calibration to delete. |
|
static |
Gets a Rx::CRxArrayString which contains unique IDs of all calibration for camera with given index uCamIdx.
asxGUIDs | [out] Rx::CRxArrayString of GUIDs. |
uCamIdx | Zero-based index of the camera. |
|
static |
Gets a Rx::CRxString which contains the GUID of the master calibration of this camera.
sxGUID | [out] Rx::CRxString of GUID. |
uCamIdx | Zero-based index of the camera. |
|
static |
Gets a Rx::CRxArrayString which contains GUIDs of all calibration on this computer.
asxGUIDs | [out] Rx::CRxArrayString of GUIDS. |
|
static |
Gets a Rx::CRxArrayString which contains GUIDs of all master calibration on this computer.
asxGUIDs | [out] Rx::CRxArrayString of GUIDS. |
|
static |
Gets the last applied calibration data.
xCalibData | [out] Information describing the calibration. |
|
static |
Gets Rx::CRxCalibMetaData for calibration with given GUID sxGUID.
xCalibData | [out] The calibration data. |
sxGUID | The GUID of the calibration. |
|
static |
Creates a new calibration and returns the GUID of the newly created calibration in sxNewGUID.
sxNewGUID | [in] Unique identifier for the new calibration. |
sxCamHardwareId | Hardware id of the camera. |
|
static |
Applies the currently bound camera calibration to the current bound image in API. Also updates to the computational class.
bApplyGrayImage | If true, the current gray image is replaced by the one from the given calibration. |
|
static |
Sets calibration data to the last applied calibration.
xCalibData | Information describing the calibration. |
|
static |
Sets Rx::CRxCalibMetaData for calibration with given GUID sxGUID.
Only certain parameters will be considered. The GUID, camera serial and camera type cannot be set.
xCalibData | The calibration data. |
sxGUID | The GUID of the calibration. |
|
static |
Gets calibration (The camera calibration) from current bound image and saves it to current calibration. Also saves database to disk.
|
static |
Gets (The camera calibration) from current bound image and saves it to the calibration defined by GUID sxGUID Also saves database to disk.
sxGUID | GUID of the calibration which should be saved. |
|
static |
Binds the given camera to the returned API image ID. Call RxCamUnBind to unbind the bound camera. Only one camera can be bound. Calling Rx::LFR::CApiLF::RxCamBind with another camera index results in an Rx::CRxException.
uCamIdx | Zero-based index of the camera. |
|
static |
Closes the given camera. If the given camera is currently bound, the camera is unbound before closing. Also, if the camera is in capture mode, the capturing is stopped before unbinding.
uCamIdx | The zero-based index of the camera to close. |
|
static |
Get a camera parameter of type Rx::CRxString.
uCamIdx | The zero-based camera index. |
ePar | The camera parameter. Allowed parameters from Rx::Interop::Runtime30::Camera::EProperty are:
|
sxValue | [out] The returned string value. |
|
static |
Get a camera parameter of type unsigned integer.
uCamIdx | The zero-based camera index. |
ePar | The camera parameter ID. Allowed parameters from Rx::Interop::Runtime30::Camera::EProperty are:
|
uValue | [out] The returned unsigned integer value. |
|
static |
Get camera parameter of type double
uCamIdx | The zero-based camera index. |
ePar | The camera parameter. Allowed parameters from Rx::Interop::Runtime30::Camera::EProperty are:
|
dValue | [out] The returned double value. |
|
static |
Get camera parameter of type Rx::CRxArrayString.
uCamIdx | The zero-based camera index. |
ePar | The camera parameter. |
aValue | [out] The returned value. |
|
static |
Get a camera parameter of type Rx::CRxString from the currently bound camera.
ePar | The camera parameter. Allowed parameters from Rx::Interop::Runtime30::Camera::EProperty are:
|
sxValue | [out] The returned string value. |
|
static |
Get a camera parameter of type unsigned integer from the currently bound camera.
|
static |
Get camera parameter of type double from the currently bound camera.
ePar | The camera parameter ID. Allowed parameters from Rx::Interop::Runtime30::Camera::EProperty are:
|
dValue | [out] The returned double value. |
|
static |
Get camera parameter of type Rx::CRxArrayString.
ePar | The camera parameter. |
aValue | [out] The returned Rx::CRxArrayString value. |
|
static |
Get the parameter range of a camera parameter of type unsigned integer.
uCamIdx | The zero-based camera index. |
ePar | The camera parameter. Allowed parameters from Rx::Interop::Runtime30::Camera::EProperty are:
|
uMin | [out] On return the minimal parameter value. |
uMax | [out] On return the maximal parameter value. |
|
static |
Get the parameter range of a camera parameter of type double
uCamIdx | The zero-based camera index. |
ePar | The camera parameter. Allowed parameters from Rx::Interop::Runtime30::Camera::EProperty are: |
dMin | [out] On return the minimal parameter value. |
dMax | [out] On return the maximal parameter value. |
|
static |
Get a set of available values for a parameter of type unsigned integer
uCamIdx | The zero-based camera index. |
ePar | The camera parameter. |
auValues | [out] The list of available values. |
|
static |
Get the parameter range of a camera parameter of type unsigned
integer
from the currently bound camera.
ePar | The camera parameter. Allowed parameters from Rx::Interop::Runtime30::Camera::EProperty are:
|
uMin | [out] On return the minimal parameter value. |
uMax | [out] On return the maximal parameter value. |
|
static |
Get the parameter range of a camera parameter of type double
from the currently bound camera.
ePar | The camera parameter. Allowed parameters from Rx::Interop::Runtime30::Camera::EProperty are: |
dMin | [out] On return the minimal parameter value. |
dMax | [out] On return the maximal parameter value. |
|
static |
Get set of available values for parameter of type unsigned.
ePar | The camera parameter. |
auValues | [out] The list of available values. |
|
static |
Test whether a camera parameter is supported by the given camera.
ePar | The camera parameter ID. |
uCamIdx | The camera index. |
|
static |
Test whether a camera parameter is supported by the currently bound camera.
ePar | The camera parameter. |
|
static |
Opens the given camera. Camera settings can only be accessed after a camera has been opened. The first call to open initializes the camera too.
uCamIdx | The zero-based index of the camera to open. |
|
static |
Register available cameras.
This functions registers all cameras that are currently available. Only registered cameras can be used by the Raytrix API. This function can be called repeatedly to update the list of available cameras. This function has to be called after Rx::LFR::CApiLF::RxCamDriverInit and before any other API camera functions.
|
static |
Register a callback function which is called when a new image is available.
pFunc | The callback function pointer. |
pvContext | [in,out] The void pointer of the Context. |
|
static |
Remove the image callback function.
|
static |
Retrieve a single image from the currently bound camera.
|
static |
Set a camera property of type Rx::CRxString.
uCamIdx | The zero-based camera index. |
ePar | The camera parameter. Allowed parameters from Rx::Interop::Runtime30::Camera::EProperty are: |
sxValue | The string value. |
|
static |
Set a camera property of type unsigned integer.
uCamIdx | The zero-based camera index. |
ePar | The camera parameter. Allowed parameters from Rx::Interop::Runtime30::Camera::EProperty are:
|
uValue | The unsigned integer value. |
|
static |
Set a camera property of type double.
uCamIdx | The zero-based camera index. |
ePar | The camera parameter. Allowed parameters from Rx::Interop::Runtime30::Camera::EProperty are:
|
dValue | The double value. |
|
static |
Set a camera property of type Rx::CRxString from the currently bound camera.
ePar | The camera parameter. Allowed parameters from Rx::Interop::Runtime30::Camera::EProperty are: |
sxValue | The string value. |
|
static |
Set a camera property of type unsigned integer from the currently bound camera.
ePar | The camera parameter. Allowed parameters from Rx::Interop::Runtime30::Camera::EProperty are:
|
uValue | The unsigned integer value. |
|
static |
Set a camera property of type double
Rx::Interop::Runtime30::Camera::EProperty::StrobeLength2
dValue | The double value. |
|
static |
Prepares the currently bound camera for capturing images. If the currently bound camera is already in capture mode, then the function throws an exception.
|
static |
Stops capturing of the currently bound camera. If the camera is not in capture mode, the function simply returns without error.
|
static |
Suspend capturing images.
This function stops the data transfer between camera and computer but keeps all other capture settings.
bSuspend | True to suspend camera capture and false to restart camera capture. |
|
static |
Triggers capturing of a single image of the currently bound camera. The image can be retrieved by calling Rx::LFR::CApiLF::RxCamRetrieveImage.
|
static |
Unbinds a currently bound camera. If the bound camera is still capturing images, the capturing is stopped and then the camera is unbound.
|
static |
Convert a Rx::CRxImage to a new pixel and data type.
xDstImage | [out] Destination image. |
xSrcImage | Reference to the image. |
eDstPixelType | Pixel type of the converted image. |
eDstDataType | Data type of the converted image. |
|
static |
Convert a Rx::CRxImage to a new pixel and data type.
pDstImage | [out] Destination image. |
pSrcImage | Reference to the image. |
eDstPixelType | Pixel type of the converted image. |
eDstDataType | Data type of the converted image. |
bCreate | if true, memory for the destination image is created by this function. |
|
static |
Returns the number of CUDA devices installed.
|
static |
Return free and total amount of memory on the selected CUDA device.
nFreeMem | [out] On return contains the amount of free memory in bytes. |
nTotalMem | [out] On return contains the amount of total memory in bytes. |
|
static |
Get the name and the compute capability major and minor version for a CUDA device.
iDevice | Zero-based ID of the CUDA device. |
sxName | [out] On return contains the name of the CUDA device. |
iCCMajor | [out] On return contains the major version of the CUDA device compute capability. |
iCCMinor | [out] On return contains the minor version of the CUDA device compute capability. |
|
static |
Select a CUDA device.
Use the functions Rx::LFR::CApiLF::RxCudaDeviceCount and Rx::LFR::CApiLF::RxCudaDeviceProp to obtain information about the installed CUDA devices and then select the most appropriate CUDA device with this function. If iDevice is set to -1, the first appropriate CUDA device is selected.
To exchange image data generated by CUDA directly with an OpenGL rendering context on the same device, bUseGL has to be set to true and the CUDA device has to support OpenGL 3.0 or higher. Note that CUDA/DirectX interop. is currently not supported.
For further details on CUDA/OpenGL interop.
iDevice | (Optional) The zero-based CUDA device ID or -1 for automatic selection. |
bUseGL | (Optional) Flag indicating whether to initialize CUDA for OpenGL interop. or not. |
|
static |
Object space depth 3D.
This creates a RGBA float image which maps each pixel in the view camera to a 3D position in object space. The R channel is the X coordinate, the G channel is the Y coordinate and the B channel is the Z coordinate. The Z coordinate is relative to the global coordinate system which typically coincides with the light field camera sensor. All coordinate values are given in millimeters.
The image is stored in the image with the ID LFR::EImage::Depth3D.
|
static |
Colorizes the depth map created by Rx::LFR::CApiLF::RxDepthMap.The result is stored in the image with the ID LFR::EImage::Depth3D.
eSpace | The space. |
|
static |
Creates a depth map from the ray depth image created by Rx::LFR::CApiLF::RxDepthRay.
eSpace | The space. |
|
static |
Estimates the depth of the bound ray image and stores the result in the image with the ID LFR::EImage::DepthRay.
|
static |
Get the IDs of an attached dongle.
iDngID | [in] On return contains the hardware dongle ID. |
iRxID | [in] On return contains the Raytrix dongle ID. |
|
static |
Close any open cameras and free all memory allocated on CUDA device and in host memory.
|
static |
Frees memory used by the image defined in eImgID
. This invalidates the image.
eImgID | The image ID. |
|
static |
Get an internal image.
The available internal image IDs are listed in Rx::LFR::CApiLF::EImgID.
eImgID | Internal image ID. This is not a ray image handle. |
xImage | [out] On return contains a copy of the specified internal image. |
|
static |
Get an internal image.
The available internal image IDs are listed in Rx::LFR::CApiLF::EImgID.
eImgID | Internal image ID. This is not a ray image handle. |
pImage | [out] On return contains a copy of the specified internal image. |
bCreate | If true, a new image is created in pImage. Otherwise, it is ensured that pImage refers to an image the same size and type as the respective internal image, and then the internal image is copied. |
|
static |
Get the device pointer of an internal image.
eImgID | Internal image ID. This is not a ray image handle. |
pDevicePtr | [out] On return contains the internal image's device pointer. |
|
static |
Gets device pointer pitch, which is the width in bytes of the allocation. Given a row and column of an array element of type T, the address is computed as:
T* pElement = (T*)((char*)BaseAddress + Row * pitch) + Column;
eImgID | Internal image ID. This is not a ray image handle. |
|
static |
Get the image format of an internal image.
eImgID | Internal image ID. This is not a ray image handle. |
xF | [out] On return contains the internal image's format. |
|
static |
Calculates the histogram of the image with the given eImgID and stores the histogram data in the given array. This array must be large enough to hold 4 * 256 numbers. The number of calculated channels is returned in uChannels.
eImgID | The image ID. |
xHistogram | [out] A reference of Rx::CRxArrayUInt where the histogram will be stored. |
uChannels | [out] The number of channels. |
|
static |
Finds the minimum and maximum value of the given eImgID
eImgID | The image ID. |
uChannel | The channel. |
fMin | [out] The minimum value. |
fMax | [out] The maximum value. |
|
static |
Gets the value of a parameter.
ePar | The ID of the parameter. |
uValue | [out] The value of the parameter. |
|
static |
Gets the value of a parameter.
ePar | The ID of the parameter. |
uValue | [out] The value of the parameter. |
|
static |
Gets the value of a parameter.
ePar | The ID of the parameter. |
dValue | [out] The value of the parameter. |
|
static |
Gets the value of a parameter.
ePar | The ID of the parameter. |
sValue | [out] The value of the parameter. |
|
static |
Gets the value of a parameter.
ePar | The ID of the parameter. |
auValue | [out] The value of the parameter. |
|
static |
Gets the value of a parameter.
ePar | The ID of the parameter. |
adValue | [out] The value of the parameter. |
|
static |
Gets the value of a parameter.
ePar | The ID of the parameter. |
asValue | [out] The value of the parameter. |
|
static |
Gets the value of a parameter.
ePar | The ID of the parameter. |
uValue | [out] The value of the parameter. |
|
static |
Gets the value of a parameter.
ePar | The ID of the parameter. |
dValue | [out] The value of the parameter. |
|
static |
Gets the value of a parameter.
ePar | The ID of the parameter. |
sValue | [out] The value of the parameter. |
|
static |
Gets the value of a parameter.
ePar | The ID of the parameter. |
auValue | [out] The value of the parameter. |
|
static |
Gets the value of a parameter.
ePar | The ID of the parameter. |
adValue | [out] The value of the parameter. |
|
static |
Gets the value of a parameter.
ePar | The ID of the parameter. |
asValue | [out] The value of the parameter. |
|
static |
Get the string representation of a parameter.
ePar | The parameter ID. |
sValue | [out] On return contains the parameter string representation. |
|
static |
Get the string representation of a parameter.
ePar | The parameter ID. |
sValue | [out] On return contains the parameter string representation. |
|
static |
Get the string representation of a parameter.
ePar | The parameter ID. |
sValue | [out] On return contains the parameter string representation. |
|
static |
Get the Properties of a parameter.
ePar | The parameter ID. |
sValue | [out] On return contains the parameter string representation. |
bReadAccess | [out] On return contains the parameter ReadAccess flag. |
bWriteAccess | [out] On return contains the parameter WriteAccess flag. |
eParameterType | [out] On return contains the parameter DataType. |
|
static |
Get the Properties of a parameter.
ePar | The parameter ID. |
sValue | [out] On return contains the parameter string representation. |
bReadAccess | [out] On return contains the parameter ReadAccess flag. |
bWriteAccess | [out] On return contains the parameter WriteAccess flag. |
eParameterType | [out] On return contains the parameter DataType. |
|
static |
Get the Properties of a parameter.
ePar | The parameter ID. |
sValue | [out] On return contains the parameter string representation. |
bReadAccess | [out] On return contains the parameter ReadAccess flag. |
bWriteAccess | [out] On return contains the parameter WriteAccess flag. |
eParameterType | [out] On return contains the parameter DataType. |
|
static |
Get the value range of a parameter.
ePar | The ID of the parameter. |
uMin | [out] The min allowed value of the parameter. |
uMax | [out] The max allowed value of the parameter. |
|
static |
Get the value range of a parameter.
ePar | The ID of the parameter. |
uMin | [out] The min allowed value of the parameter. |
uMax | [out] The max allowed value of the parameter. |
|
static |
Get the value range of a parameter.
ePar | The ID of the parameter. |
dMin | [out] The min allowed value of the parameter. |
dMax | [out] The max allowed value of the parameter. |
|
static |
Get the value range of an array parameter and the min and max allowed number of elements in the array.
ePar | The ID of the parameter. |
iMinCount | [out] The min number of values allowed in the array. |
iMaxCount | [out] The max number of values allowed in the array. |
uMin | [out] The min allowed value of the parameter. |
uMax | [out] The max allowed value of the parameter. |
|
static |
Get the value range of an array parameter and the min and max allowed number of elements in the array.
ePar | The ID of the parameter. |
iMinCount | [out] The min number of values allowed in the array. |
iMaxCount | [out] The max number of values allowed in the array. |
dMin | [out] The min allowed value of the parameter. |
dMax | [out] The max allowed value of the parameter. |
|
static |
Get the value range of a parameter.
ePar | The ID of the parameter. |
uMin | [out] The min allowed value of the parameter. |
uMax | [out] The max allowed value of the parameter. |
|
static |
Get the value range of a parameter.
ePar | The ID of the parameter. |
dMin | [out] The min allowed value of the parameter. |
dMax | [out] The max allowed value of the parameter. |
|
static |
Get the value range of an array parameter and the min and max allowed number of elements in the array.
ePar | The ID of the parameter. |
iMinCount | [out] The min number of values allowed in the array. |
iMaxCount | [out] The max number of values allowed in the array. |
uMin | [out] The min allowed value of the parameter. |
uMax | [out] The max allowed value of the parameter. |
|
static |
Get the value range of an array parameter and the min and max allowed number of elements in the array.
ePar | The ID of the parameter. |
iMinCount | [out] The min number of values allowed in the array. |
iMaxCount | [out] The max number of values allowed in the array. |
dMin | [out] The min allowed value of the parameter. |
dMax | [out] The max allowed value of the parameter. |
|
static |
Gets the release date of this version of the Raytrix Light Field Runtime. Can be called without initializing the API.
iDay | [out] The release day. |
iMonth | [out] The release month. |
iYear | [out] The release year. |
|
static |
Assigns the OpenGL context created by Rx::LFR::CApiLF::RxCudaSelectDevice to the calling thread.
|
static |
Get the OpenGL texture ID corresponding to given parameter eImgID
The content of this texture can be updated with the Rx::LFR::CApiLF::RxGlUpdateTex function.
eImgID | The image ID. |
uGlTextureID | [out] Identifier for the OpenGL texture. |
|
static |
Get the OpenGL texture ID corresponding to given parameter eImgID
The content of this texture can be updated with the Rx::LFR::CApiLF::RxGlUpdateTex function.
eImgID | The image ID. |
|
static |
Get OpenGL version of current OpenGL rendering context.
iMajor | [out] On return contains the OpenGL major version. |
iMinor | [out] On return contains the OpenGL minor version. |
|
static |
Releases the OpenGL context owned by the calling thread.
|
static |
Store the threads current OpenGL context. The context can be retrieved with RxGlGetContext() and released with RxGlReleaseContext.
|
static |
Copy CUDA result images to OpenGL textures.
The internal image IDs that can be used with this function are those declared in Rx::LFR::CApiLF::EImgID. Combining a number of image IDs by OR, updates all the related textures.
uIntImgIDs | Internal image ID. A number of internal image IDs can be combined with OR operation. |
bCreateMipmaps | (optional) the create mipmaps flag. |
|
static |
Show a lens grid overlay on the raw ray image.
The result is written to the internal image with ID LFR::EImage::Grid.
|
static |
Automatically calibrates the MLA rotation steps and the MLA reflection. Requires master dongle feature.
|
static |
Automatically calibrates MLA grid. Requires master dongle feature.
|
static |
Automatically calibrates MLI grid.
|
static |
Pre Process a ray image with a minimal Set of preprocessing parameter.
This function does the same preprocessing as Rx::LFR::CApiLF::RxPreProcess but all preprocessing flags with exception of debayering are deactivated.
|
static |
Enables or disables a callback during automatic grid calibration via RxGridCalibrateMli, RxGridCalibrateMla and RxGridCalibrateMaster.
bEnable | True to enable, false to disable. |
|
static |
Test whether the Dongle offers the given features.
uFeatureIDs | A OR-ed list of Rx::Dongle::ERuntimeFeature::ID to check for availability. |
|
static |
Test whether the Dongle offers a given feature.
eFeatureID | The feature to check for availability. |
|
static |
Initialize the Raytrix API.
bUseCUDA | (Optional) 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 (Rx.CameraNet.Type*.dll). |
sxCalibPath | (Optional) The absolute path to the camera calibration directories. |
pvData | [in,out] (Optional) Reserved. Must be zero. |
|
static |
Test whether an internal image is valid.
eImgID | Internal image ID. This is not a ray image handle. |
true
if the image is valid, false
otherwise.
|
static |
Loads all writable API parameter from file. Its mandatory to bind a light field image before.
sxFilename | The filename. |
|
static |
Locks the CUDA Mutex.
iTimeout | If the mutex is locked, the timeout defines the time in ms until a Rx::CRxException is thrown. |
|
static |
Creates a multi view image and stores the result in the image with the ID LFR::EImage::Multiview_ViewCamera.
|
static |
Pre-Process a ray image.
The ray image that is bound with RxRayBind() is a raw lightfield image. Before this ray image can be used by the actual processing algorithms, it has to be adjusted by applying a rectification of a possible radial distortion and by adjusting its brightness and color with respect to a gray image.
|
static |
Projects an array of points from the given source space into the given target space.
adTrgPoints | [out] The array of projected points. |
adSrcPoints | The array of points to project. |
eTrgSpace | The target space. |
eSrcSpace | The source space. |
|
static |
Projects the given source depth value into the given target space.
dSrcDepth | The source depth in millimeter or virtual depths. |
eSrcSpace | The source space. |
bSrcVD | True if the source depth is given in virtual depths. Is ignored if the source space isn't virtual. |
eTrgSpace | The target space. |
bTrgVD | True if the target depth should be given in virtual depths. Is ignored if the target space isn't virtual. |
|
static |
Bind a ray image to perform computations on.
uRayHandle | The ID of the light field image that is to be used for calculations. |
|
static |
Save calibration data of ray image in XML format.
uRayHandle | The ID of the ray image whose calibration data is to be saved. |
sxFilename | The complete file path under which to save the data. |
|
static |
Get the calibration data of the given ray image as XML string.
uRayHandle | The ID of the ray image whose calibration data is to be saved. |
sxXml | [out] On successful return contains the XML string. |
|
static |
Delete the image with the given ID.
uRayHandle
is currently bound by a previous call to Rx::LFR::CApiLF::RxRayBind or Rx::LFR::CApiLF::RxCamStartCapture, the image is not deleted and an exception is thrown.uRayHandle | The handle of the ray image to delete. |
|
static |
Gets the pointer to the internal camera format.
|
static |
Get the image format of a ray image.
uRayHandle | The ray image handle. |
xF | [out] On return contains the image format of the ray image. |
|
static |
Gets the frame ID of the given light field image. Used when working with sequences or cameras.
uRayHandle | The ID of the light field image created by calling RxRayLoad, RxRaySeqBind or RxCamBind. |
|
static |
Gets the frame ID of the bound light field image. Used when working with sequences or cameras.
|
static |
Get meta data of a ray image.
The meta data class CRxMetaData can contain any number of meta data elements of types unsigned, double and Rx::CRxString. You can get, set and add elements to the meta data instance and store this together with the ray image.
xMetaData | [out] Contains the ray image meta data on return. |
uImgID | The ray image handle. |
|
static |
Get the meta data of the bound ray image.
The meta data class CRxMetaData can contain any number of meta data elements of types unsigned, double and Rx::CRxString. You can get, set and add elements to the meta data instance and store this together with the ray image.
xMetaData | [out] Contains the ray image meta data on return. |
|
static |
Get the ray image as Rx::CRxImage instance.
uRayHandle | The ray image handle. |
xRawImage | [out] On return contains the ray image. |
|
static |
Get the ray image.
uRayHandle | The ray image handle. |
pRawImage | [out] Pointer to an IImage interface. |
bCreate | Flag whether to create image. |
|
static |
Gets the image timestamp of the given light field image. Is 0 if the image hasn't a valid timestamp. You can use this timestamp and the timestamp of another camera or sequence frame to determine the time between them.
uRayHandle | The ID of the light field image created by calling RxRayLoad, RxRaySeqBind or RxCamBind. |
|
static |
Gets the image timestamp of the bound light field image. Is 0 if the image hasn't a valid timestamp. You can use this timestamp and the timestamp of another camera or sequence frame to determine the time between them.
|
static |
Load a ray image.
sxFilename | The ray image filename. |
|
static |
Create a new ray image.
The allowed pixel types of ray images are
Returns the ray handle, which you can use in:
xF | The ray image format. |
|
static |
Saves the given light field image to the given file.
This augments the meta data with information from the current light field environment and saves them along the image data. These information contain the current algorithm parameter.
uRayHandle | The ID of the light field image created by calling RxRayLoad, RxRaySeqBind or RxCamBind. |
sxFilename | The complete file path. |
bUpdateMetaData | True to update the current meta data so that they are available in the next call to RxRayGetMetaData; false to update a COPY of the current meta data so that they are NOT available in the next call to RxRayGetMetaData. |
|
static |
Saves the bound light field image to the given file.
This augments the meta data with information from the current light field environment and saves them along the image data. These information contain the current algorithm parameter.
sxFilename | The complete file path. |
bUpdateMetaData | True to update the current meta data so that they are available in the next call to RxRayGetMetaData; false to update a COPY of the current meta data so that they are NOT available in the next call to RxRayGetMetaData. |
|
static |
Bind a ray sequence for use by other API functions.
Only one ray sequence for reading and one ray sequence for writing can be bound at a time. When a ray sequence is bound for reading, then any currently bound ray image is unbound, a new prototype ray image of the format of the ray sequence is created and bound and the first image of the ray sequence is loaded into the bound ray image.The ID of the newly created ray image is returned. No new ray image can be bound until the ray sequence is unbound using Rx::LFR::CApiLF::RxRaySeqUnbind .If a camera capture is started while a ray sequence is bound for reading, the ray sequence is automatically unbound. While a camera is in capture mode, no ray sequence can be bound for reading.
When a ray sequence is bound for writing a ray image must already be bound. If the ray sequence is empty up to now, the ray sequence is created for the currently bound image type and only ray images of the same format can be written to the ray sequence.Also only ray images of the same format can be bound while the ray sequence is bound. If the ray sequence already contains images, it can only be bound if the currently bound ray image format is of the same format as the ray sequence. If a ray sequence in write mode is bound and camera capture is started the ray sequence is also unbound if the image formats do not agree.To capture frames from a camera, first start the camera capture, then bind the ray sequence in write mode and set the parameter Rx::LFR::Params::EApiLF::RaySeq_AutoStoreCamFrames to 1. The value returned is the ray image ID of the currently bound ray image.
uRaySeqHandle | The id of the ray sequence. |
|
static |
Close a ray sequence.
uRaySeqHandle | The id of the ray sequence. |
|
static |
Get the doubleshot mode used when recording the given sequence.
uRaySeqHandle | The ray sequence id. |
|
static |
Get the total file size of the ray sequence in bytes.
uRaySeqHandle | The ray sequence id. |
uFileSize | [out] Contains the total size of the ray sequence in bytes. |
|
static |
Get number of frame buffers in use.
uRaySeqHandle | The ray sequence id. |
|
static |
Receive ray sequence frame count.
uRaySeqHandle | Identifier for the ray sequence. |
|
static |
Get number of frames in ray sequence that is currently bound in read mode.
|
static |
Get current frame index of ray sequence.
uRaySeqHandle | The ray sequence id. |
|
static |
Determines if a sequence is bound for reading to the API.
|
static |
Move the frame index relative to the current position in the ray sequence.
uRaySeqHandle | The ray sequence id. |
iStep | The number of frames to move. Negative values move frame index backward. |
|
static |
Open a ray sequence. Depending on the mode a ray sequence can be opened for reading or writing.
sxFilename | The complete file path to the ray sequence. |
uMode | The ray sequence mode. This is a combination of elements of Rx::ERaySeqMode . |
uFrameBufferCount | The number of frame buffers used for buffered writing/reading. |
|
static |
Read a frame from the currently bound ray sequence.
|
static |
Set the current frame index of ray sequence.
uRaySeqHandle | The ray sequence id. |
uFrameIdx | The frame index. |
|
static |
Unbind a ray sequence. If a ray sequence in write mode is unbound, the currently bound ray image stays bound. No more images can be written to the ray sequence once it has been unbound, however, the ray sequence has not been closed. It can be bound again to write further ray images to it.
If a ray sequence in read mode is unbound, the currently bound ray image stays bound. The ray image is therefore also not removed from memory.
uRaySeqHandle | The ray sequence ID of the ray sequence to unbind. |
|
static |
Write currently bound ray image to currently bound ray sequence.
This function appends the currently bound ray image to the bound ray sequence.
|
static |
Set meta data of a ray image.
uRayHandle | The ray image handle. |
xMetaData | The ray image meta data to set. |
|
static |
Unbind the currently bound ray image.
|
static |
Focus image to a plane perpendicular to the optical axis, i.e. parallel to the image plane.
This focuses to a plane perpendicular to the optical axis. To change the focal plane, use parameter Rx::LFR::Params::EApiLF::Focus_RelativeFocusPlane. A relative focus value of zero refocuses to the plane furthest away from the viewer and a value of 1 would focus to a plane that passes through the object side focal point of the recording lens.
The result is written to the internal image with ID LFR::EImage::RefocusBasic. The size of this resultant image is set in relation to the ray image size via the parameter Rx::LFR::Params::EApiLF::Focus_ImageDivisor.
|
static |
Removes the computation filter mask image set by Rx::LFR::CApiLF::RxSetComputationFilterMask.
|
static |
Removes a registered message callback function.
pFunc | The function. |
pvContext | [in] If non-null, the context. |
|
static |
Resets all parameters to their default value.
|
static |
Resize an image.
xDstImage | [out] The target image to store the result. |
xSrcImage | [in] The image that is to be resized. |
iDivider | [in] The image size divider. For example, if iDivder = 2, then the resultant image size is half the original size. |
|
static |
Saves the 3D mesh provided by image 'Depth3D' to binary STL format. This requires a valid image computed by Rx::LFR::CApiLF::RxDepth3D. Triangles with a depth-variation larger than 'dMaxEdgeLength' for at least one vertex pair are not added to the mesh.
sxFilename | The complete file path. |
bUseVD | True to save the mesh in virtual depth units instead of metric units. |
dMaxEdgeLength | (Optional) Limit for depth-variation in vertices. -1 = infinity. |
|
static |
Saves the 3D mesh provided by image 'Depth3D' to binary STL format. This requires a valid image computed by Rx::LFR::CApiLF::RxDepth3D. Triangles with a depth-variation larger than 'dMaxEdgeLength' for at least one vertex pair are not added to the mesh.
sxFilename | The complete file path. |
bUseVD | True to save the mesh in virtual depth uni ts instead of metric units. |
dMaxEdgeLength | Limit for depth-variation in vertices. -1 = infinity. |
dCropLeftPerc | the percentage of the cropping on the left side. |
dCropRightPerc | the percentage of the cropping on the right side. |
dCropTopPerc | the percentage of the cropping on the top side. |
dCropBottomPerc | the percentage of the cropping on the bottom side. |
|
static |
Saves the depth values of the current Depth3D image to the given file as a point list.
The formats available are:
ASCII:
Binary:
sxFilename | The complete file path. |
bUseVD | True to save the point list in virtual depth units instead of metric units. |
|
static |
Saves the depth values of the current Depth3D image to the given file as a point list.
The formats available are:
ASCII:
Binary:
sxFilename | The complete file path. |
bUseVD | True to save the point list in virtual depth units instead of metric units. |
dCropLeftPerc | The crop left perc. |
dCropRightPerc | The crop right perc. |
dCropTopPerc | The crop top perc. |
dCropBottomPerc | The crop bottom perc. |
|
static |
Saves all writable API parameter to file. Its mandatory to bind a light field image before.
sxFilename | The filename. |
|
static |
Sets details about the application that uses this runtime currently. Saving a ray file will write this details into the meta data of the file.
sxAppName | The application name. |
sxAppVersion | The application version. |
|
static |
Sets the computation filter mask image.
This image is used to reduce the number of lenses used for depth estimation (Rx::LFR::CApiLF::RxDepthRay).
It must have the same dimension as the raw image and a pixel type of Rx::Interop::Runtime28::EPixelType::Lum and a data type of Rx::Interop::Runtime28::EDataType::UByte.
Each lens of the raw image has a lens center that can be rounded to a pixel. If this pixel has the value 255 in the filter mask image, the corresponding lens is used. If this pixel has another value, the lens is not used.
xImage | The computation filter mask image. |
|
static |
Sets the computation filter mask image.
This image is used to reduce the number of lenses used for depth estimation (Rx::LFR::CApiLF::RxDepthRay).
It must have the same dimension as the raw image and a pixel type of Rx::Interop::Runtime28::EPixelType::Lum and a data type of Rx::Interop::Runtime28::EDataType::UByte.
Each lens of the raw image has a lens center that can be rounded to a pixel. If this pixel has the value 255 in the filter mask image, the corresponding lens is used. If this pixel has another value, the lens is not used.
sxFilename | The complete file path of the computation filter mask image to load. |
|
static |
Set an internal image.
The available internal image IDs are listed in Rx::LFR::CApiLF::EImgID.
A new ray image can be set with eImgID set to LFR::EImage::Raw and a new gray image with LFR::EImage::Gray. RxSetImage copies the image data into the currently bound ray image and to the CUDA device. For the new ray image to be used in calculations you must call Rx::LFR::CApiLF::RxPreProcess after setting the ray and the gray image.
You can also circumvent the internal preprocessing of the ray image by writing directly the processed ray image to the CUDA device with LFR::EImage::Processed_Normalized. However, this will not change the LFR::EImage::Raw or LFR::EImage::Gray images currently bound.
eImgID | Internal image ID. This is not a ray image handle. |
xImage | The image to copy into the specified internal image. |
|
static |
Set an internal image.
The available internal image IDs are listed in Rx::LFR::CApiLF::EImgID.
A new ray image can be set with eImgID set to LFR::EImage::Raw and a new gray image with LFR::EImage::Gray. RxSetImage copies the image data into the currently bound ray image and to the CUDA device. For the new ray image to be used in calculations you must call Rx::LFR::CApiLF::RxPreProcess after setting the ray and the gray image.
You can also circumvent the internal preprocessing of the ray image by writing directly the processed ray image to the CUDA device with LFR::EImage::Processed_Normalized. However, this will not change the LFR::EImage::Raw or LFR::EImage::Gray images currently bound.
eImgID | Internal image ID. This is not a ray image handle. |
pImage | The image to copy into the specified internal image. |
|
static |
Sets the value of a parameter.
ePar | The ID of the parameter. |
uValue | [in] The value of the parameter. |
|
static |
Sets the value of a parameter.
ePar | The ID of the parameter. |
uValue | [in] The value of the parameter. |
|
static |
Sets the value of a parameter.
ePar | The ID of the parameter. |
dValue | [in] The value of the parameter. |
|
static |
Sets the value of a parameter.
ePar | The ID of the parameter. |
sValue | [in] The value of the parameter. |
|
static |
Sets the value of a parameter.
ePar | The ID of the parameter. |
auValue | [in] The value of the parameter. |
|
static |
Sets the value of a parameter.
ePar | The ID of the parameter. |
adValue | [in] The value of the parameter. |
|
static |
Sets the value of a parameter.
ePar | The ID of the parameter. |
asValue | [in] The value of the parameter. |
|
static |
Sets the value of a parameter.
ePar | The ID of the parameter. |
uValue | [in] The value of the parameter. |
|
static |
Sets the value of a parameter.
ePar | The ID of the parameter. |
dValue | [in] The value of the parameter. |
|
static |
Sets the value of a parameter.
ePar | The ID of the parameter. |
sValue | [in] The value of the parameter. |
|
static |
Sets the value of a parameter.
ePar | The ID of the parameter. |
auValue | [in] The value of the parameter. |
|
static |
Sets the value of a parameter.
ePar | The ID of the parameter. |
adValue | [in] The value of the parameter. |
|
static |
Sets the value of a parameter.
ePar | The ID of the parameter. |
asValue | [in] The value of the parameter. |
|
static |
Focus on a depth surface.
In principle, each pixel of the result image can be focused individually. The function Rx::LFR::CApiLF::RxTotalFocus makes this property available by focusing the ray image to the depth surface given in the internal depth image related to the target space that is selected. To calculate the depth image you have to call Rx::LFR::CApiLF::RxDepthRay first and next Rx::LFR::CApiLF::RxDepthMap, or by a user defined image set with Rx::LFR::CApiLF::RxSetImage.
When setting a depth image with Rx::LFR::CApiLF::RxSetImage it need not have the same dimensions as the resultant image. The given depth map is implicitly scaled to the size of the resultant refocused image.
If the size of the given depth map image is 1x1 pixel, the depth encoded for that pixel is applied to all focused pixel. The depth image has to be of pixel type Rx::Interop::Runtime28::EPixelType::Lum and data type Rx::Interop::Runtime28::EDataType::UByte. The pixel value range of [0,255] is mapped to [0,1] for the interpretation as depth.
eSpace | The space. |
|
static |
Unlocks the CUDA Mutex.