Raytrix Light Field SDK  v3.1
Logo
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events Groups Pages
Rx::Net::ApiLF Class Reference

Detailed Description

API LF class.

Public Types

enum  ECalibGridImageType
 Calibration image types. More...
 
enum  ECalibGridMode
 Calibration grid mode. More...
 
enum  EImageStackingOperation
 Image stacking operation modes. More...
 
enum  EImgID
 Raytrix Light Field Image IDs. More...
 
enum  EMetricCalibPointFilter
 Metric calibration point filter. These enums are to be used as a filter when getting points from the metric calibration. More...
 
enum  EMetricCalibPointType
 Values that represent . More...
 
enum  EMetricCalibrationType
 The enum that represent the type of metric calibration algorithm. More...
 
enum  EMetricCalibResult
 Metric calibration result. More...
 
enum  EMlaCalibResult
 Mla Calibration Image. More...
 
enum  EPar
 The main parameter enum of the Raytrix Light Field API. More...
 
enum  EParameterDataType
 Parameter Data Type. More...
 
enum  EParGrp
 Parameter group IDs. More...
 
enum  EPivParticleType
 PIV particle descriptor types. These enums describe the type of descriptor used for sub-pixel refinement (gauss,sphere...) More...
 
enum  EPivRejectionCause
 PIV particle rejection causes. These enums provide information on the cause of rejection. Valid particles have cause 'None'. More...
 
enum  EProjectionType
 Projection type that can be used with parameter EPar::Projection_Type. More...
 
enum  ERadDistType
 Radial image distortion types. More...
 
enum  ERaySeqMode
 Ray sequence file modes. These enums can be used as a bit mask to combine various modes. More...
 
enum  ESpace
 Values that represent the space for the projection system. More...
 
enum  EValueMapping
 Describes the mapping of the value. More...
 
enum  RuntimeFeature
 Values that represent the space for the projection system. More...
 

Public Member Functions

delegate void CamImageAvailableHandler (unsigned uCamIdx)
 Handler, called when the camera image available. More...
 
delegate void CamImageCallbackHandler (unsigned uCamIdx, void *pvContext)
 

Static Public Member Functions

static void RxAutoDepthPlanes ()
 Do an automatic adaption of the depth planes. More...
 
static void RxCalibDBBindCalib (System::String^ sGUID, bool bApplyWhiteImage)
 Applies calibration (The camera calibration) defined by GUID sGUID to the currently bound image in API. Also updates the computational class. More...
 
static void RxCalibDBBindCalibWhiteImage ([Out] unsigned% uImgID, System::String^ sGUID)
 Bind white image of calibration to API and use this image as white image too. Now you can calibrate a calibration without using a camera. More...
 
static System::String^ RxCalibDBBoundCameraNewCalib ()
 Creates a new calibration. More...
 
static System::String^ RxCalibDBCameraNewCalib (unsigned uCamIdx)
 Creates a new calibration. More...
 
static void RxCalibDBCaptureBoundCalibWhiteImage ()
 Captures 5 image from camera and processes them to one white image that is stored in calibration database in current calibration. More...
 
static void RxCalibDBCaptureCalibWhiteImage (System::String^ sGUID)
 Captures 5 image from camera and processes them to one white image that is stored in calibration database in given calibration. More...
 
static void RxCalibDBCreateDataBase (System::String^ sCamHardwareId, 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 (System::String^ sGUID)
 Deletes camera calibration with GUID sGUID. More...
 
static void RxCalibDBGetCameraCalibGuidList ([Out] array< System::String^ >^%asGUIDs, unsigned uCamIdx)
 Gets an array which contains unique IDs of all calibration for camera with given index uCamIdx. More...
 
static void RxCalibDBGetCameraMasterCalibGuid ([Out] System::String^ %sGUID, unsigned uCamIdx)
 Gets a string which contains the GUID of the master calibration of this camera. More...
 
static void RxCalibDBGetCompleteCalibGuidList ([Out] array< System::String^ >^%asGUIDs)
 Gets a array which contains GUIDs of all calibration on this computer. More...
 
static void RxCalibDBGetCompleteMasterCalibGuidList ([Out] array< System::String^ >^%asGUIDs)
 Gets a string array which contains GUIDs of all master calibration on this computer. More...
 
static void RxCalibDBLoadBoundCalibMetaData ([Out] Rx::Net::CalibMetaData^ %xCalibData)
 Gets the last applied calibration data. More...
 
static void RxCalibDBLoadCalibMetaData ([Out] Rx::Net::CalibMetaData^ %xCalibData, System::String^ sGUID)
 Gets Rx::Net::CalibMetaData for calibration with given GUID sGUID. More...
 
static System::String^ RxCalibDBNewCalib (System::String^ sCamHardwareId)
 Creates a new calibration and returns the GUID of the newly created calibration. More...
 
static void RxCalibDBReloadBoundCalib (bool bApplyWhiteImage)
 Applies the currently bound camera calibration to the current bound image in API. Also updates to the computational class. More...
 
static void RxCalibDBSaveBoundCalibMetaData (Rx::Net::CalibMetaData^ xCalibData)
 Sets calibration data to the last applied calibration. More...
 
static void RxCalibDBSaveCalibMetaData (Rx::Net::CalibMetaData^ xCalibData, System::String^ sGUID)
 Sets Rx::Net::CalibMetaData for calibration with given GUID sGUID. 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 (System::String^ sGUID)
 Gets (The camera calibration) from current bound image and saves it to the calibration defined by GUID sGUID. 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::Net::ApiLF::RxCamBind with another camera index results in an Rx::Net::ApiLF::CRxApiException. 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 RxCamDriverInit ()
 Initialize the camera drivers. More...
 
static void RxCamGetPar (unsigned uCamIdx, Rx::Net::ApiLF::EPar ePar, [Out] System::String^ %sValue)
 Get a camera parameter of type String. More...
 
static void RxCamGetPar (unsigned uCamIdx, Rx::Net::ApiLF::EPar ePar, [Out] unsigned% uValue)
 Get a camera parameter of type unsigned integer. More...
 
static void RxCamGetPar (unsigned uCamIdx, Rx::Net::ApiLF::EPar ePar, [Out] double% dValue)
 Get camera parameter of type double. More...
 
static void RxCamGetPar (unsigned uCamIdx, Rx::Net::ApiLF::EPar ePar, [Out] array< System::String^ >^%aValue)
 Get camera parameter of type 'string[]'. More...
 
static void RxCamGetPar (Rx::Net::ApiLF::EPar ePar, [Out] System::String^ %sValue)
 Get a camera parameter of type String from the currently bound camera. More...
 
static void RxCamGetPar (Rx::Net::ApiLF::EPar ePar, [Out] unsigned% uValue)
 Get a camera parameter of type unsigned from the currently bound camera. More...
 
static void RxCamGetPar (Rx::Net::ApiLF::EPar ePar, [Out] double% dValue)
 Get camera parameter of type double from the currently bound camera. More...
 
static void RxCamGetPar (Rx::Net::ApiLF::EPar ePar, [Out] array< System::String^ >^%aValue)
 Get camera parameter of type string array. More...
 
static void RxCamGetParRange (unsigned uCamIdx, Rx::Net::ApiLF::EPar ePar, [Out] unsigned% uMin, [Out] unsigned% uMax)
 Get the parameter range of a camera parameter of type unsigned integer. More...
 
static void RxCamGetParRange (unsigned uCamIdx, Rx::Net::ApiLF::EPar ePar, [Out] double% dMin, [Out] double% dMax)
 Get the parameter range of a camera parameter of type double. More...
 
static void RxCamGetParRange (unsigned uCamIdx, Rx::Net::ApiLF::EPar ePar, [Out] array< unsigned >^%auValues)
 Get a set of available values for a parameter of type unsigned array. More...
 
static void RxCamGetParRange (Rx::Net::ApiLF::EPar ePar, [Out] unsigned% uMin, [Out] unsigned% uMax)
 Get the parameter range of a camera parameter of type unsigned integer from the currently bound camera. More...
 
static void RxCamGetParRange (Rx::Net::ApiLF::EPar ePar, [Out] double% dMin, [Out] double% dMax)
 Get the parameter range of a camera parameter of type double from the currently bound camera. More...
 
static void RxCamGetParRange (Rx::Net::ApiLF::EPar ePar, [Out] array< unsigned >^%auValues)
 Get set of available values for parameter of type uint[]. More...
 
static void RxCamIsParameterSupported (unsigned uCamIdx, Rx::Net::ApiLF::EPar ePar, [Out] bool% bSupported)
 Test whether a camera parameter is supported by the selected camera. More...
 
static bool RxCamIsParameterSupported (unsigned uCamIdx, Rx::Net::ApiLF::EPar ePar)
 Test whether a camera parameter is supported by the selected camera. More...
 
static void RxCamIsParameterSupported (Rx::Net::ApiLF::EPar ePar, [Out] bool% bSupported)
 Test whether a camera parameter is supported by the currently bound camera. More...
 
static bool RxCamIsParameterSupported (Rx::Net::ApiLF::EPar 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 bool RxCamRetrieveImage ()
 Retrieve a single image from the currently bound camera. More...
 
static void RxCamSetPar (unsigned uCamIdx, Rx::Net::ApiLF::EPar ePar, System::String^ sValue)
 Set a camera property of type String. More...
 
static void RxCamSetPar (unsigned uCamIdx, Rx::Net::ApiLF::EPar ePar, unsigned uValue)
 Set a camera property of type unsigned integer. More...
 
static void RxCamSetPar (unsigned uCamIdx, Rx::Net::ApiLF::EPar ePar, double dValue)
 Set a camera property of type double. More...
 
static void RxCamSetPar (Rx::Net::ApiLF::EPar ePar, System::String^ sValue)
 Set a camera property of type String from the currently bound camera. More...
 
static void RxCamSetPar (Rx::Net::ApiLF::EPar ePar, unsigned uValue)
 Set a camera property of type unsigned integer from the currently bound camera. More...
 
static void RxCamSetPar (Rx::Net::ApiLF::EPar 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. This function stops the data transfer between camera and computer but keeps all other capture settings. More...
 
static void RxCamTrigger ()
 Triggers capturing of a single image of the currently bound camera. The image can be retrieved by calling Rx::Net::ApiLF::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::Net::Image^ %xDstImage, Rx::Net::Image^ xSrcImage, Rx::InteropNet::Runtime28::EPixelType eDstImageType, Rx::InteropNet::Runtime28::EDataType eDstDataType)
 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 ([Out] System::UInt64% uFreeMem, [Out] System::UInt64% uTotalMem)
 Return free and total amount of memory on the selected CUDA device. More...
 
static void RxCudaDeviceProp (int iDevice, System::String^ %sName, unsigned% uCCMajor, unsigned% uCCMinor)
 Get the name and the compute capability major and minor version for a CUDA device. More...
 
static void RxCudaSelectDevice (int iDevice, bool bUseGL)
 Select a CUDA device. More...
 
static void RxDepth3D ()
 Object space depth 3D. More...
 
static void RxDepthColorCode ()
 Colorizes the depth map created by Rx::Net::ApiLF::RxDepthMap. More...
 
static void RxDepthMap ()
 Creates a depth map from the ray depth image created by Rx::Net::ApiLF::RxDepthRay. More...
 
static void RxDepthRay ()
 Estimates the depth of the bound ray image and stores the result in the image with the ID Rx::Net::ApiLF::EImgID::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 (Rx::Net::ApiLF::EImgID eImgID)
 Frees memory used by image defined by eImgID. This invalidates the image. More...
 
static void RxGetImage (Rx::Net::ApiLF::EImgID eImgID, [Out] Rx::Net::Image^ %xImage)
 Get an internal image. More...
 
static void RxGetImage (Rx::Net::ApiLF::EImgID eImgID, Rx::InteropNet::Runtime28::IImage^ xImageIfc, bool bCreate)
 Get an internal image. More...
 
static void RxGetImageDevicePointer (Rx::Net::ApiLF::EImgID eImgID, System::IntPtr% pDevicePtr)
 Get the device pointer of an internal image. More...
 
static void RxGetImageFormat (Rx::Net::ApiLF::EImgID eImgID, [Out] Rx::Net::ImageFormat^ %xF)
 Get the image format of an internal image. More...
 
static void RxGetImageHistogram (Rx::Net::ApiLF::EImgID eImgID, array< unsigned >^%xHistogram, [Out] unsigned% uChannels)
 Calculates the histogram of the image with the given ID 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 (Rx::Net::ApiLF::EImgID eImgID, unsigned uChannel, [Out] float% fMin, [Out] float% fMax)
 Finds the minimum and maximum value of the given image ID. More...
 
static double RxGetLastExecTime ()
 Get last execution time of a CUDA algorithm. More...
 
static void RxGetPar (Rx::Net::ApiLF::EPar ePar, [Out] unsigned% uValue)
 Gets the value of a parameter. More...
 
static void RxGetPar (Rx::Net::ApiLF::EPar ePar, [Out] double% dValue)
 Gets the value of a parameter. More...
 
static void RxGetPar (Rx::Net::ApiLF::EPar ePar, [Out] System::String^ %sValue)
 Gets the value of a parameter. More...
 
static void RxGetPar (Rx::Net::ApiLF::EPar ePar, [Out] array< unsigned >^%auValue)
 Gets the value of a parameter. More...
 
static void RxGetPar (Rx::Net::ApiLF::EPar ePar, [Out] array< double >^%adValue)
 Gets the value of a parameter. More...
 
static void RxGetPar (Rx::Net::ApiLF::EPar ePar, [Out] array< System::String^ >^%asValue)
 Gets the value of a parameter. More...
 
static void RxGetPar (Rx::Net::ApiLF::EPar ePar, unsigned uIndex, [Out] unsigned% uValue)
 Gets the value of an array parameter at the given index. More...
 
static void RxGetPar (Rx::Net::ApiLF::EPar ePar, unsigned uIndex, [Out] double% dValue)
 Gets the value of an array parameter at the given index. More...
 
static void RxGetPar (Rx::Net::ApiLF::EPar ePar, unsigned uIndex, [Out] System::String^ %sValue)
 Gets the value of an array parameter at the given index. More...
 
static void RxGetParName (Rx::Net::ApiLF::EPar ePar, [Out] System::String^ %aValue)
 Get the string representation of a parameter. More...
 
static void RxGetParProperties (Rx::Net::ApiLF::EPar ePar, [Out] System::String^ %sName, [Out] bool% bReadAccess, [Out] bool% bWriteAccess, Rx::Net::ApiLF::EParameterDataType% eType)
 Get the Properties of a parameter. More...
 
static void RxGetParRange (Rx::Net::ApiLF::EPar ePar, [Out] unsigned% uMin, [Out] unsigned% uMax)
 Get the value range of a parameter. More...
 
static void RxGetParRange (Rx::Net::ApiLF::EPar ePar, [Out] double% dMin, [Out] double% dMax)
 Get the value range of a parameter. More...
 
static void RxGetParRange (Rx::Net::ApiLF::EPar ePar, [Out] int% iMinCount, [Out] int% iMaxCount, [Out] unsigned% uMin, [Out] 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::Net::ApiLF::EPar ePar, [Out] int% iMinCount, [Out] int% iMaxCount, [Out] double% dMin, [Out] 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 RxGetRegistryString (System::String^ sPath, System::String^ %sValue)
 Read a string from the Windows registry. More...
 
static System::DateTime RxGetReleaseDate ()
 Gets the release date of this version of the Raytrix Light Field Runtime. Can be called without initializing the API. More...
 
static double RxGetTime ()
 Gets the current time in milliseconds as double value. More...
 
static System::Int64 RxGetTime64 ()
 Gets the current time in milliseconds as 64 bit integer value. More...
 
static void RxGlGetContext ()
 Assigns the OpenGL context created by Rx::Net::ApiLF::RxCudaSelectDevice to the calling thread. More...
 
static void RxGlGetTextureID (Rx::Net::ApiLF::EImgID eImgID, [Out] unsigned% uGlTextureID)
 Get the OpenGl texture ID corresponding to given parameter eImgID. The content of this texture can be updated with the Rx::Net::ApiLF::RxGlUpdateTex function. More...
 
static unsigned RxGlGetTextureID (Rx::Net::ApiLF::EImgID eImgID)
 Get the OpenGl texture ID corresponding to given parameter eImgID. The content of this texture can be updated with the Rx::Net::ApiLF::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 RxGlUpdateTex (unsigned uIntImgIDs)
 Copy CUDA result images to OpenGL textures. More...
 
static void RxGlUpdateTex (unsigned uIntImgIDs, bool bCreateMipmaps)
 Copy CUDA result images to OpenGL textures. More...
 
static void RxGrid ()
 Show a lens grid overlay on the raw ray image. More...
 
static void RxGridDataImage ()
 Pre Process a ray image with a minimal Set of preprocessing parameter. More...
 
static bool RxHasFeature (unsigned uFeatureIDs)
 Test whether the Dongle offers the given features. More...
 
static bool RxHasFeature (Rx::Net::ApiLF::RuntimeFeature eFeatureID)
 Test whether the Dongle offers a given feature. More...
 
static void RxInit ()
 Initialize the Raytrix API. More...
 
static void RxInit (System::String^ sLibPath, System::String^ sCalibPath)
 Initialize the Raytrix API. More...
 
static void RxInit (bool bInitCuda, System::String^ sLibPath, System::String^ sCalibPath)
 Initialize the Raytrix API. More...
 
static bool RxIsImageValid (Rx::Net::ApiLF::EImgID eImgID)
 Test whether an internal image is valid. More...
 
static void RxLoadParameter (System::String^ sFilename)
 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 RxLogConsoleAddMessage (Rx::Net::EStatusSource eSource, Rx::Net::EStatusMessage eMsg, System::String^ pcSource, System::String^ pcMessage, int iValue)
 Raytrix log console add message. More...
 
static void RxLogConsoleClose ()
 Raytrix log console close. More...
 
static void RxLogConsoleShow ()
 Raytrix log console show. More...
 
static void RxMapValue ([Out] double% dTrg, double dSrc, Rx::Net::ApiLF::EValueMapping eValueMapping)
 Map a given source value via the EValueMapping::ID eValueMapping. More...
 
static void RxMetricCalibAddBoundImage ([Out] unsigned% uObjectId)
 Add the currently bound image to metric calibration. More...
 
static void RxMetricCalibApplyCalibrationToBoundImage ()
 Apply the computed metric calibration to a newly bound image. More...
 
static void RxMetricCalibEvaluatePointSpaceCoverage ([Out] array< double >^%adAreaCovered)
 Evaluate the metric calibration data set. More...
 
static void RxMetricCalibExecute (Rx::Net::ApiLF::EMetricCalibResult eResult, bool bCalibrateAfterInit)
 Performs the metric calibration. More...
 
static void RxMetricCalibFinalize ()
 Clears the metric calibration. More...
 
static void RxMetricCalibFindPoints (Rx::Net::Image^ xImage, [Out] array< double, 2 >^%amatPointEllipses)
 Raytrix metric calib transform bound image to point model. More...
 
static void RxMetricCalibGetAddImageResult (unsigned uObjectId, [Out] Rx::Net::MetricCalibAddImageResult^ %AddObjectResult)
 Get result to an object id. More...
 
static void RxMetricCalibGetAllObjectIds ([Out] array< unsigned >^%auObjectIds)
 Get all valid object ids from the metric calibration. More...
 
static void RxMetricCalibGetModelsList ([Out] array< double, 2 >^%amatModelsList)
 Get the list of all models extracted from the added image. More...
 
static void RxMetricCalibGetPointConnections (unsigned uId, Rx::Net::ApiLF::EMetricCalibPointType ePointType, [Out] array< double, 2 >^%amatLines)
 Get All point connections. More...
 
static void RxMetricCalibGetPointEllipses (unsigned uId, Rx::Net::ApiLF::EMetricCalibPointFilter ePointFilter, Rx::Net::ImageFormat^ xTargetImageFormat, [Out] array< double, 2 >^%matPointEllipses)
 Get the list of specific point ellipses. More...
 
static void RxMetricCalibGetPoints (unsigned uId, Rx::Net::ApiLF::EMetricCalibPointFilter ePointFilter, Rx::Net::ApiLF::EMetricCalibPointType ePointType, [Out] array< double, 2 >^%amatPoints)
 Get specific points from the models. More...
 
static void RxMetricCalibGetRefocusedImage (unsigned uObjectId, Rx::Net::Image^ xImage)
 Get the refocused image from the metric calibration. More...
 
static void RxMetricCalibGetResult ([Out] Rx::Net::MetricCalibResult^ %xMetricCalibResult)
 Evaluated the calibration result. That is, the error function of the calibration is executed once with the current parameter settings and mean residual, mean euclidean distance, min euclidean distance, max euclidean distance and the standard deviation. Note that this function also projects all test points of all test models to object space. More...
 
static void RxMetricCalibInitialize (Rx::Net::ApiLF::EMetricCalibrationType eCalibrationType)
 Initialize metric calibration. More...
 
static void RxMetricCalibLoadCalibration (System::String^ sFilename)
 Load a '.rxcalib' file from file system, containing a calibrated system. More...
 
static void RxMetricCalibLoadPlanarModelData (System::String^ sFilename, [Out] array< unsigned >^%auObjectIds)
 Load planar model data. More...
 
static void RxMetricCalibProjectPointsIntoObjectSpace (array< double, 2 >^amatPoints, Rx::Net::Image^ xDepthImage, [Out] array< double, 2 >^%amatPoints3D)
 Receive metric calib projection points into object space. More...
 
static void RxMetricCalibRegisterCallbackFunctionWithMessageHandler (bool bRegister)
 Registers the callback function of the metric calibration to the api message handler. More...
 
static void RxMetricCalibRemoveModelFromCalibrationSet (unsigned nObjectId)
 Removes the models of the object given by its object id from the calibration set. Changes the result information related to this object id. You can receive the information of an object by calling Rx::Net::ApiLF::RxMetricCalibGetAddImageResult(unsigned, Rx::CRxMetricCalibAddImageResult);. More...
 
static void RxMetricCalibResetToNominal ()
 Reset the metric calibration to nominal values. More...
 
static void RxMetricCalibSaveCalibration (System::String^ sFilename)
 Save the converged calibration result. More...
 
static void RxMetricCalibSavePlanarModelData (System::String^ sFilename)
 Save planar model to filesystem. More...
 
static void RxMlaCalibExecute ([Out] Rx::Net::ApiLF::EMlaCalibResult% eResult, bool bIgnoreImageQuality)
 Calibrate the micro lens image grid using white image from bound image. More...
 
static void RxMlaCalibGetGridData ([Out] array< double >^%aLensData, [Out] double% dLensRadius, unsigned uLensType)
 Get the lens center positions of given type in pixel coordinates. The corresponding lensRadius is returned. More...
 
static bool RxMlaCalibParallelLightExecute ()
 Calibrate the MLA properties using a parallel light image. Calibration has to be augmented by a white-image calibration to be valid. More...
 
static void RxMlaCalibRegisterCallbackFunction (bool bActivate)
 Enables/Disables progress callback of Rx::Net::ApiLF::RxMlaCalibExecute / Rx::Net::ApiLF::RxMlaCalibParallelLightExecute. More...
 
static void RxMultiview ()
 Creates a multi view image and stores the result in the image with the ID Rx::Net::ApiLF::EImgID::Multiview_ViewCamera. More...
 
static void RxPreProcess ()
 Pre-Process a ray image. More...
 
static bool RxProject ([Out] array< double >^%adTargetPoint, array< double >^adSourcePoint, Rx::Net::ApiLF::ESpace eTarget, Rx::Net::ApiLF::ESpace eSource)
 Projects an array of points from the given source space into the given target space. More...
 
static void RxRayBind (unsigned uRayHandle)
 Bind a ray image to perform computations on. More...
 
static void RxRayCalibLoadXML (unsigned uRayHandle, System::String^ sFilename)
 Load calibration data of ray image from XML file. More...
 
static void RxRayCalibSaveXML (unsigned uRayHandle, System::String^ sFilename)
 Save calibration data of ray image in XML format. More...
 
static void RxRayCalibXmlGet (unsigned uRayHandle, System::String^ %sXml)
 Get the calibration data of the given ray image as XML string. More...
 
static void RxRayCalibXmlSet (unsigned uRayHandle, System::String^ sXml)
 Set the calibration data of the given ray image from an XML string. More...
 
static void RxRayDelete (unsigned uRayHandle)
 Delete the image with the given ID. More...
 
static Rx::Net::ImageFormatRxRayGetFormat (unsigned uRayHandle)
 Get the image format of a ray image. More...
 
static Rx::Net::MetaData^ RxRayGetMetaData (unsigned uImgID)
 Get meta data of a ray image. More...
 
static void RxRayGetRaw (unsigned uRayHandle, Rx::Net::Image^ %xRawImage)
 Get the ray image as Rx::Net::Image instance. More...
 
static void RxRayGetRaw (unsigned uRayHandle, Rx::InteropNet::Runtime28::IImage^ IRawImage, bool bCreate)
 Get the ray image. More...
 
static unsigned RxRayLoad (System::String^ sFilename)
 Load a ray image. More...
 
static unsigned RxRayNew (Rx::Net::ImageFormat^ xF)
 Create a new ray image. More...
 
static void RxRaySave (unsigned uRayHandle, System::String^ sFilename)
 Saves the ray image described by ID uRayHandle. More...
 
static void RxRaySave (System::String^ sFilename)
 Saves the currently bound ray image. More...
 
static unsigned RxRaySeqBind (unsigned uRaySeqID)
 Bind a ray sequence for use by other API functions. More...
 
static unsigned RxRaySeqClose (unsigned uRaySeqID)
 Close a ray sequence. More...
 
static void RxRaySeqGetFileSize (unsigned uRaySeqID, System::UInt64% uFileSize)
 Get the total file size of the ray sequence in bytes. More...
 
static unsigned RxRaySeqGetFrameBufferUsedCount (unsigned uRaySeqID)
 Get number of frame buffers in use. More...
 
static unsigned RxRaySeqGetFrameCount (unsigned uRaySeqID)
 Get number of frames in ray sequence. More...
 
static unsigned RxRaySeqGetFrameCount ()
 Get number of frames in ray sequence that is currently bound in read mode. More...
 
static unsigned RxRaySeqGetFrameIndex (unsigned uRaySeqID)
 Get current frame index of ray sequence. More...
 
static bool RxRaySeqIsBound ()
 Determines if a sequence is bound to the API. More...
 
static void RxRaySeqMoveFrameIndex (unsigned uRaySeqID, int iStep)
 Move the frame index relative to the current position in the ray sequence. More...
 
static unsigned RxRaySeqOpen (System::String^ sFilename, 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 uRaySeqID, unsigned uFrameIdx)
 Set the current frame index of ray sequence. More...
 
static void RxRaySeqUnbind (unsigned uRaySeqID)
 Unbind a ray sequence. If a ray sequence in write mode is unbound, the currently bound ray image also 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 uImgID, Rx::Net::MetaData^ 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::Net::ApiLF::RxSetComputationFilterMask. More...
 
static void RxResizeImage (Rx::Net::Image^ %xDstImage, Rx::Net::Image^ %xSrcImage, int iDivider)
 Resize an image. More...
 
static void RxSaveDepth3dMesh (System::String^ sFilename, double dMaxEdgeLength)
 Saves the 3D mesh provided by image 'Depth3D' to binary STL format. This requires a valid image computed by Rx::Net::ApiLF::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 (System::String^ sFilename, double dMaxEdgeLength, double dCropLeftPerc, double dCropRightPerc, double dCropTopPerc, double dCropBottomPerc)
 Saves the 3D mesh provided by image 'Depth3D' to binary STL format. This requires a valid image computed by Rx::Net::ApiLF::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 (System::String^ sFilename)
 Saves the depth values of the current Depth3D image to the given file as a point list. More...
 
static void RxSaveDepth3dPointList (System::String^ sFilename, double dCropLeftPerc, double dCropRightPerc, double dCropTopPerc, double dCropBottomPerc)
 Saves the depth values of the current Depth3D image to the given file as a point list. More...
 
static void RxSaveParameter (System::String^ sFilename)
 Saves all writable API parameter to file. Its mandatory to bind a light field image before. More...
 
static void RxSetComputationFilterMask (Rx::Net::Image^ xImage)
 Sets the computation filter mask image. More...
 
static void RxSetComputationFilterMask (System::String^ sFilename)
 Sets the computation filter mask image. More...
 
static void RxSetImage (Rx::Net::ApiLF::EImgID eImgID, Rx::Net::Image^ xImage)
 Set an internal image. More...
 
static void RxSetImage (Rx::Net::ApiLF::EImgID eImgID, Rx::InteropNet::Runtime28::IImage^ xImageIfc)
 Set an internal image. More...
 
static void RxSetPar (Rx::Net::ApiLF::EPar ePar, unsigned uValue)
 Sets the value of a parameter. More...
 
static void RxSetPar (Rx::Net::ApiLF::EPar ePar, double dValue)
 Sets the value of a parameter. More...
 
static void RxSetPar (Rx::Net::ApiLF::EPar ePar, System::String^ sValue)
 Sets the value of a parameter. More...
 
static void RxSetPar (Rx::Net::ApiLF::EPar ePar, array< unsigned >^auValue)
 Sets the value of a parameter. More...
 
static void RxSetPar (Rx::Net::ApiLF::EPar ePar, array< double >^adValue)
 Sets the value of a parameter. More...
 
static void RxSetPar (Rx::Net::ApiLF::EPar ePar, array< System::String^ >^asValue)
 Sets the value of a parameter. More...
 
static void RxSetPar (Rx::Net::ApiLF::EPar ePar, unsigned uIndex, unsigned uValue)
 Sets the value of an array parameter at the given index. More...
 
static void RxSetPar (Rx::Net::ApiLF::EPar ePar, unsigned uIndex, double dValue)
 Sets the value of an array parameter at the given index. More...
 
static void RxSetPar (Rx::Net::ApiLF::EPar ePar, unsigned uIndex, System::String^ sValue)
 Sets the value of an array parameter at the given index. More...
 
static void RxSleep (unsigned uTime)
 Pause calling thread for the given number of milliseconds. More...
 
static void RxTotalFocus ()
 Focus on a depth surface. More...
 
static void RxUnlockCudaMutex ()
 Unlocks the CUDA Mutex. More...
 

Events

static CamImageAvailableHandler^  CamImageAvailable [add, remove, raise]
 Event queue for all listeners interested in CamImageAvailable events. More...
 
static
Rx::Net::StatusMessageHandler^  
StatusMessage [add, remove, raise]
 Event queue for all listeners interested in StatusMessage events. More...
 

Member Enumeration Documentation

Calibration image types.

Enumerator
White 

Use a white image only calibration. 'Old' standard calibration determining properties of regular grid.

Parallel 

Use calibration for parallel light images. Basic hardware calibration performed once for each camera. Gives orientation etc. for physical lens grid.

WhiteForParallel 

For an available parallel light calibration determine additional white image calibration. Relates distorted/scaled lens images in white image to physical lens array by parallel calibration.

Calibration grid mode.

Enumerator
Full 

Calibrate only center position of grid and micro image scale.

Reduced 

Calibration for homography omitting radial distortions.

Plain 

Calibration for center position, lens pitch and MLA rotation only.

Image stacking operation modes.

Enumerator
None 
Mean 
Add 

Raytrix Light Field Image IDs.

Enumerator
None 
Raw 

Raw image.

White 

Ray calibration (white) image.

DepthRay 

Raw depth image.

Grid 

Grid result image.

Processed_Normalized 

Processed ray image.

GridDataImage 

The Grid Data Image.

RefocusBasic 

Focus image on depth map of virtual space.

TotalFocus_VirtualSpace 

Total Focus image of virtual space.

TotalFocus_ObjectSpace 

Total Focus image of object space.

TotalFocus_ViewCamera 

Total Focus result image.

Multiview_ViewCamera 

Multiview image.

DepthMap_VirtualSpace 

Depth image in virtual space.

DepthMap_ObjectSpace 

Depth image in space object.

DepthMap_ViewCamera 

Depth result image.

DepthMapColored_VirtualSpace 

Depth color result image for virtual space.

DepthMapColored_ViewCamera 

Depth color result image for view camera.

Depth3D 

Depth map mapping image. This is created by RxDepthMapObjectSpace(). See the documentation of this function.

Metric calibration point filter. These enums are to be used as a filter when getting points from the metric calibration.

Enumerator
PlanarModelAll 

All points from the planar model.

PlanarModelWithDepth 

All points from the planar model with an accomplished depth calculation.

TestModelAll 

All points from the test model.

TestModelAllButAxes 

All points from the test model but those that lie on the axes.

TestModelAxisX 

All points from the test model that lie on the x-axis.

TestModelAxisY 

All points from the test model that lie on the y-axis.

Values that represent .

Enumerator
Model2dIX 

Index of points.

Model3dMM_m 

3D Point placed in the sensor coordinate system in mm

Space2MM_s 

2D Point placed in the sensor coordinate system in mm

Space2MM_g 

2D Point placed in the global coordinate system in mm

Space4MM_g 

Point placed in the object coordinate system in mm.

Space4PlaneMM_g 

Point projected on the plane.

Model3dSpace4MM_g 

Model point in object space.

Space2VD_s 

2D Point placed in the sensor coordinate system and z in virtual depth

ErrorByDepth 

The first entry is the virtual depth, the second is the mm depth in space 4 in the global coordinate system and the last value in the vector is the euclidean distance of the test model point to the ground truth model point after calibration

The enum that represent the type of metric calibration algorithm.

Enumerator
None 
PlaneBased 

The calibration based on a calibration setup that demands tilted dot target images that reach over a large part of the depth range.

BoxBased 

The calibration based on a calibration setup that demands straight dot target images that are moved along the z-axis with known steps.

Metric calibration result.

Enumerator
None 
Converged 

The calibration has successfully converged.

Diverged 

The calibration diverged.

TooManyIterations 

The calibration aborted after too many iteration. This threshold can be set via the Api Parameter: Rx::ApiLF::EPar::MC_CalibrationIterationCount.

InsufficientData 

The calibration aborted because the data was insufficient.

UserInterrupt 

The calibration aborted because an user interrupt.

Error 

The calibration aborted because an error occurred.

Mla Calibration Image.

Enumerator
None 
Converged 

The calibration has successfully converged.

Diverged 

The calibration diverged.

ImageUnideal 

The input image does not correspond with the ideal calibration image –> Possible reason: Too bright , Too dark ,... .

UserInterrupt 

The calibration aborted because an user interrupt.

Error 

The calibration aborted because an error occurred.

enum Rx::Net::ApiLF::EPar
strong

The main parameter enum of the Raytrix Light Field API.

Attention
This enum contains the parameters IDs for various library and camera parameters. There are six possible types the parameters can have:
  • unsigned integer or unsigned integer array
  • double or double array
  • string or string array

Also parameters can have a range of valid values and a default value. Furthermore, parameters can be:

  • read only(RO)
  • write only(WO)
  • read write(RW)

The parameter type and the access type are indicated for each parameter.

At the end of a parameter's comment all mentioned information is found: (type,range:default,permission)

Enumerator
None 
Cuda_DeviceName 

CUDA The name of the CUDA device (string,-:"",RO)

Cuda_DeviceID 

The device ID of the selected CUDA device (unsigned,-:0,RO)

Cuda_CapaMajor 

The compute capability major version (unsigned,-:0,RO)

Cuda_CapaMinor 

The compute capability minor version (unsigned,-:0,RO)

Cuda_VersionRuntime 

CUDA device runtime version (unsigned,-:0,RO)

Cuda_VersionDriver 

CUDA device driver version (unsigned,-:0,RO)

Cuda_TotalGlobalMem 

CUDA device total global memory (unsigned,-:0,RO)

Cuda_RegsPerBlock 

CUDA device registers per block (unsigned,-:0,RO)

Cuda_WarpSize 

CUDA device warp size (unsigned,-:0,RO)

Cuda_MemPitch 

CUDA device memory pitch (unsigned,-:0,RO)

Cuda_MaxThreadsPerBlock 

CUDA device maximal number of threads per block (unsigned,-:0,RO)

Cuda_TotalConstMem 

CUDA device total constant memory (unsigned,-:0,RO)

Cuda_DeviceOverlap 

CUDA device concurrent memory copy and kernel execution (unsigned,-:0,RO)

Cuda_MultiProcessorCount 

CUDA device number of processors (unsigned,-:0,RO)

Cuda_ComputeMode 

CUDA device compute mode (unsigned,-:0,RO)

Cuda_MaxTex2DSizeX 

CUDA device maximum 2D texture size x-dimension (unsigned,-:0,RO)

Cuda_MaxTex2DSizeY 

CUDA device maximum 2D texture size y-dimension (unsigned,-:0,RO)

Cuda_MaxTex2DArraySizeX 

CUDA device maximum 2D array texture size x-dimension (unsigned,-:0,RO)

Cuda_MaxTex2DArraySizeY 

CUDA device maximum 2D array texture size y-dimension (unsigned,-:0,RO)

Cuda_ConcurrentKernels 

CUDA device can execute kernels concurrently (unsigned,-:0,RO)

Cuda_TCCDriver 

CUDA device is a Tesla device using a TCC driver (unsigned,-:0,RO)

Cam_Count 

Camera parameter Number of cameras available (unsigned,-:-,RO)

Cam_DriverName 

Raytrix camera type name. E.g. 'TypeD' or 'TypeE' (string,-:-,RO)

Cam_ModelName 

Raytrix camera model name or internal model name if not calibrated. (string,-:-,RO)

Cam_HardwareId 

Unique camera hardware id (string, RO)

Cam_Serial 

Raytrix camera serial or internal hardware serial if not calibrated (string,-:-,RO)

Cam_Exposure 

Camera exposure in milliseconds (double,-:-,RW)

Cam_TapBalance 

Camera tap balance (double,[-1,1]:-,RW)

Cam_Gain 

Camera gain (double,[0,100]:0,RW)

Cam_GainRed 

Camera gain for red color channel (double,[0,100]:0,RW)

Cam_GainGreen 

Camera gain for green color channel (double,[0,100]:0,RW)

Cam_GainBlue 

Camera gain for blue color channel (double,[0,100]:0,RW)

Cam_IsColor 

If camera is a color camera this is set to 1, otherwise to 0 (unsigned,[0,1]:-,RO)

Cam_IsBayer 

If camera is in bayer mode this is set to 1, otherwise to 0 (unsigned,[0,1]:-,RO)

Cam_Width 

Width of image returned by camera (unsigned,-:-,RO)

Cam_Height 

Height of image returned by camera (unsigned,-:-,RO)

Cam_OffsetX 

Offset in X-direction (unsigned,-:-,RO)

Cam_OffsetY 

Offset in Y-direction (unsigned,-:-,RO)

Cam_FramesPerSecond 

Target for captured frames per second (double,-:-,RW)

Cam_ActualFramesPerSecond 

Estimate of actual captured frames per second (double,-:-,RO)

Cam_Focus 

Main lens focus setting (double,-:-,RW)

Cam_Iris 

Main lens iris setting (double,-:-,RW)

Cam_Func_CalibMainLens 

Execute main lens calibration for controllable lenses (unsigned,-:-,RW)

Cam_TapBalanceMode 

Tap Balance Mode (string,-:-,RW)

Cam_PIVMode 

PIV Mode (unsigned,[0,1]:0,RW)

Cam_IsOpen 

Test whether a camera is open (unsigned,[0,1]:-,RO)

Cam_IsCapturing 

Test whether a camera is in capture mode (unsigned,[0,1]:-,RO)

Cam_Temperature 

Temperature of camera (double,-:-,RO)

Cam_TriggerMode 

Sets the camera trigger mode. This replaces the old Cam_IsVideoMode. (enum,Rx::Interop::Runtime30::Camera::ETriggerMode:-,RW)

Cam_SourceImageFolder 

For virtual camera reading image files, this gives the folder where the driver checks for new images. (string,-:-,RW)

Cam_ExternalTriggerMode 

DO NOT CHANGE - Sets the type of the external trigger mode. (enum,Rx::Camera::EExternalTriggerMode:Rx::Camera::EExternalTriggerMode::TriggerCam,RW)

CamCap_Timeout_Video 

Camera Capture Time in milliseconds before a timeout exception is thrown if no image has been received from the camera in video mode. Default is zero. (unsigned,-:0,RW)

CamCap_Timeout_Single 

Time in milliseconds before a timeout exception is thrown if no image has been received from the camera in single capture mode. Default is 10000. (unsigned,-:10000,RW)

CamCap_Timeout_Extern 

Time in milliseconds before a timeout exception is thrown if no image has been received from the camera in external trigger mode. Default is zero. (unsigned,-:0,RW)

CamCap_FrameBuffer_TotalCount 

The total number of camera frames that can be stored in the buffer loop. The default is 1. (unsigned,[1,10000]:1,RW)

CamCap_FrameBuffer_Overwrite 

If set to 0 frame buffers already in use are NOT overwritten by new camera images. Instead new camera images are ignored. If set to 1, frame buffers in use are overwritten by new camera images. The default is 1. (unsigned,[0,1]:1,RW)

CamCap_FrameBuffer_FreeCount 

Gets the number of free frame buffers in the buffer loop. (unsigned,-:-,RO)

CamCap_FrameBuffer_UsedCount 

Gets number of used frame buffers in the buffer loop. (unsigned,-:-,RO)

CamCap_Frames_Lost 

Count of lost frames since last image capture start. (unsigned,-:-,RO)

CamCap_AutoLum_MaxSaturatedPixelPercentage 

The maximal percentage of pixels that are allowed to be overexposed before the luminance (gain and/or shutter) is reduced (double,[0.0,10.0]:0.01,RW).

CamCap_AutoGain_Enabled 

If set to 1 auto gain is enabled. Captured images are processed by the API and the camera gain is adjusted appropriately. (unsigned,[0,1]:0,RW)

CamCap_AutoGain_Active 

This value is set by the API to indicate whether the auto gain algorithm is currently adapting the camera gain. (unsigned,[0,1]:-,RO)

CamCap_AutoGain_MinValue 

The minimal gain value set by the auto gain. (unsigned,[0,100]:0,RW)

CamCap_AutoGain_MaxValue 

The maximal gain value set by the auto gain. (unsigned,[0,100]:100,RW)

CamCap_AutoExposure_Enabled 

If set to 1 auto exposure is enabled. Captured images are processed by the API and the camera shutter speed is adjusted appropriately. (unsigned,[0,1]:0,RW)

CamCap_AutoExposure_Active 

This value is set by the API to indicate whether the auto gain algorithm is currently adapting the camera exposure time. (unsigned,[0,1]:-,RO).

CamCap_AutoExposure_MinValue 

The minimal exposure time set by auto exposure in milliseconds. (double,[0.0,1000000.0]:0.0,RW)

CamCap_AutoExposure_MaxValue 

The maximal exposure time set by auto exposure in milliseconds. (double,[0.0,1000000.0]:1000.0,RW)

Ray_Width 

Bound ray image parameter The width of the currently bound ray image (unsigned,-:-,RO)

Ray_Height 

The height of the currently bound ray image (unsigned,-:-,RO)

Ray_PixelType 

The pixel type of the currently bound ray image (enum,Rx::Interop::Runtime28::EPixelType:-,RO)

Ray_DataType 

The data type of the currently bound ray image (enum,Rx::Interop::Runtime28::EDataType:-,RO)

Ray_ApplyWhiteImage 

Flag whether to apply a white image to the raw ray image or not (unsigned,[0,1]:1,RW)

Ray_ConvBayer 

Flag whether to apply a debayer filter or not (unsigned,[0,1]:0,RW)

Ray_ApplyFileSettings 

Flag whether parameter settings stored in ray file are applied when loading image (unsigned,[0,1]:1,RW)

Gray_CaptureDelay 

Gray image properties The delay in seconds between each image of the gray image capturing routine (unsigned,[0,-]:0,RW)

Gray_CaptureCount 

The number of image the actual white image is averaged from. (unsigned, [1,-]:5,RW)

Gl_TexRayID 

OpenGL Interop OpenGL texture name for ray image (unsigned,-:-,WO)

Gl_TexFocusLeftID 

OpenGL texture name for standard focus and left focus image (unsigned,-:-,WO)

Gl_TexFocusRightID 

OpenGL texture name for right focus image (unsigned,-:-,WO)

Gl_TexDepthLeftID 

OpenGL texture name for standard depth and left depth image (unsigned,-:-,WO)

Gl_TexDepthRightID 

OpenGL texture name for right depth image (unsigned,-:-,WO)

Gl_TexDepthColLeftID 

OpenGL texture name for standard depth color and left depth color image (unsigned,-:-,WO)

Gl_TexDepthColRightID 

OpenGL texture name for right depth color image (unsigned,-:-,WO)

Gl_TexGridID 

OpenGL texture name for grid image (unsigned,-:-,WO)

Gl_TexFocusLeftID2 

second OpenGL texture name for standard focus and left focus image (unsigned,-:-,WO)

Gl_TexFocusRightID2 

second OpenGL texture name for right focus image (unsigned,-:-,WO)

Gl_TexDepthMap 

OpenGL texture name depth map (unsigned,-:-,WO)

Gl_TexRayProcID 

OpenGL texture name for processed raw image (unsigned,-:-,WO)

Gl_TexRayWhiteID 

OpenGL texture name for raw white image (unsigned,-:-,WO)

Gl_TexRayDepthID 

OpenGL texture name for raw depth image (unsigned,-:-,WO)

Gl_TexStereoID 

OpenGL texture name for stereo image. (unsigned,-:-,WO)

Gl_TexDepthObjSpcID 

OpenGL texture name for the object space depth image (unsigned,-:-,WO)

Gl_TexFocusObjSpcID 

OpenGL texture name for the focus image for the object space depth image (unsigned,-:-,WO)

Gl_TexDepthUndistortedID 

OpenGL texture name for the undistorted depth image (unsigned,-:-,WO)

Gl_TexFocusUndistortedID 

OpenGL texture name for the focus image for the object space depth image (unsigned,-:-,WO)

Gl_TexDepthVirtualSpaceID 

OpenGL texture name for the virtual space depth image (unsigned,-:-,WO)

Gl_TexFocusVirtualSpaceID 

OpenGL texture name for the focus image for the virtual space depth image (unsigned,-:-,WO)

Gl_TexDepthColLeftID2 

OpenGL texture name for left depth color image (unsigned,-:-,WO)

RaySeq_AutoStoreCamFrames 

Ray sequence Automatically store frames captured from a camera into the bound ray sequence in write mode (unsigned,[0,1]:0,RW)

RaySeq_ApplyFileSettings 

Flag whether parameter settings stored in ray sequence file are applied when loading sequence (unsigned,[0,1]:1,RW)

RaySeq_AutoStoreCamFrameCnt 

Number of frames that are stored when RaySeq_AutoStoreCamFrames is set to 1. If value is zero, then there is no limit on the number of frames stored. If value is larger than zero, the value is decremented for each frame recorded. When the value reaches zero, RaySeq_AutoStoreCamFrames is set to zero and no more frames are stored. (unsigned,[0,max]:0,RW)

PreProc_Std_Enable 

Ray PreProcess Algorithm Enable Standard Preprocessing of ray image (unsigned,[0,1]:0,RW)

PreProc_Std_Brightness 

Standard preprocessing: brightness gain (double,[0.0,1e5]:1.0,RW)

PreProc_Std_ContrastCenter 

Standard preprocessing: contrast center (double,[0.0,1.0]:0.5,RW)

PreProc_Std_ContrastScale 

Standard preprocessing: contrast scale (double,[0.0,2.0]:0.0,RW)

PreProc_Std_Gradation 

Set of points in range [0,1] describing the gradation curve. ATTENTION: Only two points are allowed at the moment. (double[],[0.0,1.0]:(0.0,0.0,1.0,1.0), RW)

PreProc_Sharp1_Enable 

Enable sharpness algorithm 1: unsharp masking (unsigned,[0,1]:1,RW)

PreProc_Sharp1_BlurStdDev 

Sharpness Algo1: Standard deviation of Gauss blurred image (double, [0.0,10.0]:2.5,RW)

PreProc_Sharp1_Factor 

Sharpness Algo1: Mixing factor of blurred image with original image as pixel * factor + blurred * (1 - factor). (double,[-2.0,3.0]:1.5,RW)

PreProc_Sharp1_OnlyCalc 

Use sharpness only for depth calculation (not for output image) (unsigned,[0,1]:1,RW)

PreProc_Demosaic_Enable 

Enable demosaic balance parameters (unsigned,[0,1]:0,RW)

PreProc_Demosaic_R 

Red balance (double,[0.0,1.0]:1.0,RW)

PreProc_Demosaic_G 

Green balance (double,[0.0,1.0]:1.0,RW)

PreProc_Demosaic_B 

Blue balance (double,[0.0,1.0]:1.0,RW)

PreProc_DenoiseNLM_Enable 

Enable Non-Local-Means denoising of raw image (unsigned,[0,1]:0,RW)

PreProc_DenoiseNLM_FilterDia 

Denoise filter diameter in pixels (unsigned,[2,8]:4,RW)

PreProc_DenoiseNLM_NoiseLevel 

Noise level (double,[0.01,2.0]:0.1,RW)

PreProc_DenoiseNLM_BlendFactor 

Blending factor (double,[0.0,0.3]:0.2,RW)

Depth_ResImgDiv 

Depth algorithm Result image size divisor for depth evaluation (double,[2.0,20.0]:4.0,RW)

Depth_DefaultValue 

Default depth value for output depth images. This value is used for all pixel, where the internal depth map has no result. (double,-:0.0,RW)

Depth_MinVirtualDepth 

Minimum virtual depth for depth estimation (double,[2.0,100.0]:2.0,RW)

Depth_MaxVirtualDepth 

Maximum virtual depth for depth estimation (double,[2.0,100.0]:15.0,RW)

Depth3D_UseVirtualDepth 

Flag to determine the usage of metric units or VD units (unsigned,[0,1]:0,RW)

Depth_Path_BlockCnt 

Depth Path algorithm Number of blocks calculated per CUDA kernel call (unsigned,[1,10000000]:50,RW)

Depth_Path_NearResLevel 

The resolution level for near objects. The higher the number the finer the depth resolution for near objects. (unsigned,[2,5]:3,RW)

Depth_Path_SparseLensSet 

Flag whether to use a sparse set of micro lenses to calculate depth. (unsigned,[0,1]:0,RW)

Depth_Path_LT_PixelStep 

Pixel step for disparity evaluation (double[12],[0.1,1.0]:0.5,RW)

Depth_Path_LT_MinStdDev 

Minimal standard deviation of correlation patch (double[12],[0.0,1.0]:0.2,RW)

Depth_Path_LT_MinCor 

Minimal correlation threshold (double[12],[0.0,1.0]:0.90,RW)

Depth_Path_LT_MinPolyParAbs 

Absolute polynomial parameter threshold. The larger the value the stronger the extrema has to be to be accepted. (double[12],[0.0,1.0]:(0.5,0.5,0.5,0.5,0.5,0.5,0.5,0.5,0.5,0.5,0.5,0.5),RW)

Depth_Path_LT_MaxPolyCtrDelta 

Maximum delta of polynomial fit extrema position to central position (double[12],[0.0,1.0]:(0.5,0.5,0.5,0.5,0.5,0.5,0.5,0.5,0.5,0.5,0.5,0.5),RW)

Depth_Path_LT_PatchDia 

Correlation patch radius (unsigned[12],[2,5]:(3,3,3,3,3,3,3,3,3,3,3,3),RW)

Depth_Path_LT_PatchStride 

Correlation patch stride (unsigned[12],[1,5]:(2,2,2,2,2,2,2,2,2,2,2,2),RW)

Depth_Fuse_MedianRad 

Depth Fuse Direct Algo Radius of median filter applied after fusion of raw depth image (unsigned,[0,10]:0,RW)

Depth_Fuse_MeanRad 

Radius of mean filter applied after fusion of raw depth image (unsigned,[0,10]:0,RW)

Depth_Fuse_MeanMaxBlackPart 

Mean filter is only applied for a black central pixel if the percentage of pixels within patch with unknown depth does not exceed this limit. (double,[0.0,1.0]:0.2,RW)

Depth_Fill_Enabled 

Depth Fill Algo Flag whether filling of depth map is enabled (unsigned,[0,1]:1,RW)

Depth_Fill_IterCnt 

Number of iterations used for filling the depth map. (unsigned,[0,10]:2,RW)

Depth_Fill_IterSize 

Size of unknown depth border filled per iteration in pixels. (unsigned,[1,100]:4,RW)

Depth_Fill_Complete 

Flag to indicate whether the remaining unknown depth areas are to be filled after the iterations. (unsigned,[0,1]:1,RW)

Depth_Fill_Median_Enabled 

Enable/Disable median filtering of filled depth map (unsigned,[0,1]:1,RW).

Depth_Fill_Median_Radius 

Radius of median filter that is applied after filling the depth map. (unsigned,[1,4]:1,RW)

Depth_Fill_Mean_Enabled 

Enable/Disable mean filtering of filled depth map (unsigned,[0,1]:1,RW).

Depth_Fill_Mean_Radius 

Radius of mean filter that is applied after filling the depth map. (unsigned,[1,10]:1,RW)

Depth_Fill_NLM_Enabled 

Enable denoise "Non Local Means" (NLM) algorithm after filling depth image (unsigned,[0,1]:0,RW)

Depth_Fill_NLM_FilterDia 

NLM filter diameter (unsigned,[2,8]:4,RW)

Depth_Fill_NLM_NoiseLevel 

NLM noise level (double,[0.01,2.0]:0.1,RW)

Depth_Fill_NLM_BlendFactor 

NLM blend factor (double,[0.0,0.3]:0.2,RW)

Depth_Fill_Bilateral_Enabled 

Flag whether bilateral filtering of depth map is enabled. (unsigned,[0,1]:0,RW)

Depth_Fill_Bilateral_FilterRad 

Bilateral filter radius (unsigned,[1,20]:10,RW)

Depth_Fill_Bilateral_Edge 

Bilateral filter sigma R (edge) (double,[0.01,0.2]:0.005,RW)

Depth_Fill_Bilateral_Range 

Bilateral filter sigma S (distance) (double,[1.0,20.0]:5.0,RW)

Focus_ResImgDiv 

Focus algorithm Result image size division factor (double,[0.0,-]:2.0,RW)

Focus_MaxLensContribRad 

Maximal radius in which lenses contribute to a resultant pixel (double,[1.0,10.0]:2.0,RW)

Focus_RelativeFocusPlane 

Focus value for refocusing onto a plane. (double,[0.0,1.0]:0.5,RW)

Focus_DefocusBlur_Enable 

DefocusBlur Enable blurring of out-of-focus areas for focusing. (unsigned, [0,1]:0, RW)

Focus_DefocusBlur_VirtDOF 

Depth of field for defocus blur as virtual depth delta (double, [0.0,10.0]:0.0,RW)

Focus_DefocusBlur_Gradient 

Gradient of defocus blur. Linear factor for blurring radius depending on virtual depth difference. (double,[0.1,30.0]:4.0,RW)

Focus_DefocusBlur_MaxBlurRad 

Maximum blur radius for defocussing. (unsigned,[1,100]:20,RW)

Focus_DefocusBlur_DefaultDepth 

Default relative depth value used for areas where no depth could be calculated. (double,[0.0,1.0]:0.5,RW)

Proj_Type 

Projection Type of the projection system. (enum,Rx::ApiLF::EProjectionType:Standard,RW)

Proj_DepthPlanesVD 

Projection depths planes in virtual depth. The Plane indices 0,1,2 represent the planes: Near / collimation / far Plane. The near and far plane will clip the depth estimation. The collimation plane is used for multi view images (e.g. Stereo). (double[3], [0,1000]:-, RW)

Proj_DepthPlanesMM 

Projection depths planes in millimeters. The Plane indices 0,1,2 represent the planes: Near / collimation / far Plane. The near and far plane will clip the depth estimation. The collimation plane is used for multi view images (e.g. Stereo). (double[3], [0,-]:-, RW)

Proj_ViewingFrustumSpace2Type 

Type of the viewing frustum in space 2 (enum,Rx::CRxLFCameraFormat::EViewingFrustumSpace2Type:ViewFrustSpc2Type_Orthographic,RW).

Proj_DepthPlanesAuto 

Disables (0) / Enables (1) automatic determination of depth planes after depth estimation (unsigned, [0,1]:0, RW).

Proj_CurrentTargetView 

An enum constant representing the current target view. (enum,Rx::Projection::ESpace:-,RW)

See also
Raytrix's Projection System - Target View
Proj_NominalFocusDistanceMM 

The nominal focus distance from the camera to the object that is to be captured. The nominal focus distance serves as an initial parameter for the metric calibration (double,[1e-9,1e6]:500,RW)

Proj_NominalFocalLengthMM 

The nominal focal length in millimeters. This parameter serves as an initial value for the metric calibration (double,[1e-4,1e5]:100,RW)

Proj_ReferencePlane 

The reference plane to which all depth values will be measured. The first three entries describe the center of the plane and the second set of three entries describe the normal of the plane (double[6],[-,+]:(0,0,0,0,0,1),RW)

Sensor_RotationMatrix_g_s 

Sensor The sensor rotation matrix from global frame in sensor frame (double[9],[-1.0,1.0]:(0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0),RW).

Sensor_TranslationMM_g_s 

The sensor translation in millimeters from global frame in sensor frame (double[3],-:(0.0,0.0,0.0),RW).

Sensor_TotalSizeMM 

The size of the camera sensor. This is always the complete sensor size, even if the image only shows part of the whole original sensor image (double[2],[0,-]:(image width,image height) RW).

Sensor_SizeMM 

The sensor size in millimeters that corresponds to the size of image that is stored with this format (double[2], [0,-]:(image width,image height),RW).

Sensor_OffsetMM 

The sensor offset in millimeters. This is the vector from the center of the total sensor which is the origin of ordinates to the center of the actual sensor size in the sensor frame. (double[2],[0,-]:(0.0,0.0),RW).

Sensor_PhysicalPixelSizeMM 

The sensors pixel size in mm. (double,[0.0,1.0]:-,RW).

VirtCamPinholeStd_ViewOffsetMM_g 

Virtual Camera Offset of image center of virtual camera in plane perpendicular to z-axis of main lens from center of main lens in millimeters (double[2],-:(0.0,0.0),RW).

VirtCamPinholeStd_ViewZoomFactor 

The zoom factor. A zoom factor of zero sets the viewing frustum to that of the main lens (double,[-2.0,2,0]:0.0,RW).

VirtCamPinholeStd_LandscapeMode 

Disables (0) / Enables (1) the Landscape Mode for the virtual Camera (unsigned,[0,1]:1,RW).

VirtCamPinholeStd_SensorScaling 

Set the Sensor Scaling mode for the virtual Camera. Has to be one of the values defined in EVirtCamSensorScaling (enum,Rx::CRxLFCameraFormat::EVirtCamSensorScaling:VirtCam_Sensor_Scale_InnerRect,RW).

VirtCamPinholeStd_SensorSizeFactor 

The virtual sensor size factor. This determines the size of the virtual camera's sensor with respect to the plenoptic camera's physical sensor size. The virtual camera's sensor size is equal to this factor times the plenoptic camera's sensor size (double,[0.1,1000]:1.0,RW).

VirtCamPinholeStd_ViewRotationDEG 

The rotation of the virtual camera about its z-axis in degrees in a CCW sense (double,[0.0,360.0]:0.0,RO).

VirtCamPinholeStd_FrustumMM_g 

The extended frustum of the virtual camera given in 6 coordinates: 1 = bottom/left/near, 2 = top/right/near, 3 = bottom/left/far, 4 = top/right/far, 5 = bottom/left/furthest, 6 = top/right/furthest (double[18],-:-,RO).

MainLensThin_OpticalAxisDir_s 

Main Lens Thin The direction of the lens's optical axis with respect to the sensor frame (double[3],[-1.0,1.0]:(0.0, 0.0, -1.0),RW).

MainLensThin_ImagePrincipalPointMM_s 

The 2d principal point on the image plane given in the sensor frame. This is the intersection point of the optical axis with the image plane. (double[2],-,:(0.0,0.0)RW).

MainLensThin_FocalLengthMM 

The main lens's focal length in millimeters (double,[0.1,1e5]:100.0,RW).

MainLensThin_TotalFocusDistanceMM 

The total focus distance in millimeters. This is the distance from the sensor plane to the focus plane (double,[0.1,1e9]:500.0,RW).

MainLensThick_OpticalAxisDir_s 

Main Lens Thick The direction of the lens's optical axis with respect to the sensor frame (double[3],[-1.0,1.0]:(0.0, 0.0, -1.0),RW).

MainLensThick_ImagePrincipalPointMM_s 

The 2d principal point on the image plane given in the sensor frame. This is the intersection point of the optical axis with the image plane. (double[2],-:(0.0,0.0),RW).

MainLensThick_FocalLengthMM 

The main lens's focal length in millimeters (double,[0.1,1e5]:100.0,RW).

MainLensThick_TotalFocusDistanceMM 

The total focus distance in millimeters. This is the distance from the sensor plane to the focus plane (double,[0.1,1e9]:500.0,RW).

MainLensThick_PlaneSeparationMM 

The principal plane separation in millimeters (double,[0.0,1e6]:0.0,RW).

Mla_LensPitchMM 

MLA The micro lens pitch in millimeters. This is the distance between neighboring micro lens centers. (double,[0.0,-]:-,RW)

Mla_LensPitchPX 

The MLA lens pitch px. (double,[0.0,-]:23.0,RW).

Mla_LensGapMM 

The micro lens gap in millimeters. The micro lens diameter is the micro lens pitch minus this gap. (double,[0.0,-]:0.001,RW)

Mla_LensGapPX 

The MLA lens gap px.(double,[0.0,-]:0.0,RW)

Mla_LensBorderMM 

The micro lens border in millimeters. The effectively usable micro lens diameter is the micro lens diameter minus twice this border. (double,[0.0,-]:PixelSize,RW)

Mla_LensBorderPX 

The MLA lens border px. (double,[0.0,-]:-,RW)

Mla_FocusRangeMinVD 

Minimal virtual depth values from where on the corresponding micro lens type gives in-focus images.(double[12],[0.0,-]:(1.0,2.8,3.8),RW)

Mla_FocusRangeMaxVD 

Maximal virtual depth values until where the corresponding micro lens type gives in-focus images (double[12],[0.0,-]:(3.0,4.0,100.0),RW).

Mla_LensTypeCount 

Number of micro lens types on the MLA (unsigned,[0,12]:-,RW).

Mla_RotationRad 

The MLA rotation in radians from sensor frame to MLA frame (double,-:0.0,RW).

Mla_OffsetMM_s 

The offset from sensor frame origin (the center of the sensor) to MLA frame in millimeters.(double[2],-:(0.0,0.0),RW)

Mla_OffsetPX_s 

The MLA offset px in sensor frame. (double[2],-:(0.0,0.0),RW)

Mla_CenterLensLocationMM 

The initial master offset from sensor frame origin to MLA frame origin in millimeters. (double[2]:(0.0,0.0),-,RW)

Mla_CenterLensLocationPX 

The MLA center lens location in pixels. (double[2],-:(0.0,0.0),RW)

Mla_InvertAxisX 

If true, the MLA frame x-axis is inverted with the respect to the standard orientation. (unsigned,[0,1]:0,RW)

Mla_InvertAxisY 

If true, the MLA frame y-axis is inverted with the respect to the standard orientation. (unsigned,[0,1]:0,RW)

Mla_Rotation90Count 

Number of 90 degree CCW rotation steps of the MLA, with respect to the standard orientation. (unsigned,[0,3]:0,RW)

Mla_MlaSensorDistanceMM 

The orthogonal distance between a micro-lens's optical center and the sensor. This may be different for each micro lens type. The values are given in millimeters. (double[12],[0.0,-]:-,RW)

Mla_NominalMlaSensorDistanceMM 

The nominal orthogonal distance between a micro-lens's optical center and the sensor. This may be different for each micro lens type. The values are given in millimeters (double[12],[0.0,-]:-,RW).

Mla_MlaBorderLU 

The MLA border in lens units. This Values defines the region of interest in various algorithms. (double,[0.0,1000.0]:1.0,RW)

Mla_NominalLensPitchMM 

The micro lens pitch in millimeters. This is the distance between neighboring micro lens centers. The rough lens pitch serves as an initial start for further more precise calibrations (double,[0.0,-]:-,RW)

Mla_NominalLensPitchPX 

The MLA nominal lens pitch px. (double,[0.0,-]:-,RW)

Mla_FocusEffectiveMinVD 

Minimal virtual depth that allow a full refocus without gaps. The parameter Mla_FocusRangeMinVD describes the absolute minimal virtual depth but is affected by the current calibration. The affected value is returned by this parameter. (double,[-,-]:-,RO)

MlaImg_RadialDistType 

MLA Image Distortion Radial distortion type of MLA grid. This specifies the distortion type that maps a regular hexagonal grid into the actual irregular grid seen in the image (enum,Rx::ERadDistType:Constant RW).

MlaImg_RadialDistParamCount 

Number of micro lens grid radial distortion parameters used (unsigned,[0,10]:0, RW).

MlaImg_RadialDistCenterPX_pxa 

Micro lens grid radial distortion center in pixel array coordinates in pixel units (double[2],-:(0.0,0.0),RW).

MlaImg_RadialUnDistParams 

Micro lens grid radial un-distortion parameters. These are the parameters for an un-distortion function that map a distorted raw pixel to an undistorted raw pixel. The result is a regular micro lens grid image (double[10],-:(0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0,0.0),RW).

MlaImg_UnDistHomographyWhiteImage 

Parameters of homography matrix for white image un-distortion (see GridCalib algorithm). Homography H is 3x3 matrix given as vector by: [h11 h12 h13 h21 h22 h23 h31 h32 h33]. (double[10],-:-,RW)

MlaImg_UnDistInvHomParallelLightImage 

Parameters of inverse of homography matrix for parallel light image un-distortion (see GridCalibParallelLight algorithm). Matrix H is 3x3 matrix given as vector by: [h11 h12 h13 h21 h22 h23 h31 h32 h33]. (double[10],-:-,RW)

MlaImg_HasParallelLightCalib 

If true, there is a parallel light calibration available (unsigned,[0,1]:0,RO)

MlaImg_CalibType 

Read the type of the MLA Calibration. This value is defined in ECalibGridMode. (enum,Rx::CRxLFCameraFormat::EMlaImageCalibrationType:MlaCalib_Plain,RO)

Multiview_Type 

Stereo Stereo type (0 = Red/Cyan, 1 = Cyan/Red, 2 = Green/Magenta, 3 = Magenta/Green, 4 = Side-By-Side, 5 = Over/Under) (unsigned,[0,5]:0,RW).

Multiview_EyeSeparation 

Stereo eye separation. (double, [1.0,20.0]:10.0,RW)

Grid_DrawOnWhiteImage 

If set to 1U, the grid is drawn on the white image. (unsigned,[0,1]:0,RW)

MC_Enable_StoreRefocusedImage 

Metric calibration parameters Store the refocused image (unsigned,[0,1]:0,RW)

MC_Enable_FocalLength 

flag for calibration of the focal length (unsigned,[0,1]:1,RW)

MC_Enable_PrinciplePlaneSeperation 

Flag for calibration of principle plane separation (unsigned,[0,1]:0,RW)

MC_Enable_OpticalAxis 

Flag for calibration of optical axis (unsigned,[0,1]:1,RW)

MC_Enable_PrinciplePoint 

Flag for calibration of principal point (unsigned,[0,1]:1,RW)

MC_Enable_MLAToSensorDistance 

Flag for calibration of MLA to sensor distance (unsigned,[0,1]:1,RW)

MC_Enable_MLALensTypeRatio 

Flag for calibration of MLA lens type ratio (unsigned,[0,1]:0,RW)

MC_Enable_Dist_Center 

Flag for distortion center (unsigned,[0,1]:1,RW)

MC_Enable_RadialPolyConst 

Flag for radial distortion const (unsigned,[0,1]:0,RW)

MC_Enable_RadialPoly 

Flag for radial distortion (unsigned,[0,1]:1,RW)

MC_Enable_DepthPoly 

Flag for depth distortion (unsigned,[0,1]:1,RW)

MC_Enable_AxialPoly 

Flag for axial distortion (unsigned,[0,1]:1,RW)

MC_CalibrationIterationCount 

Number of calibration iterations (unsigned,[0,1]:50,RW)

MC_TestModelFilter_SmoothRadius 

Smooth radius for test model filter (unsigned,[0,1]:3,RW)

MC_TestModelFilter_OutlierThresholdVD 

outliers threshold for test model filter (double,[0.0,1.0]:0.1,RW)

MC_TestModelFilter_DepthStdDevThresholdVD 

Depth threshold for test model filter (double,[0.0,1.0]:0.25,RW)

MC_TestModelFilter_Hist3dHorizBinCount 

Horizontal histogram bin count -> same for vertical (unsigned,[0,-]:15,RW)

MC_TestModelFilter_Hist3dDepthBinCount 

Depth histogram bin count -> same for vertical (unsigned,[0,-]:20,RW)

MC_TestModelFilter_Hist3dVirtDepthMin 

Min value for depth histogram (double,[0,-]:2.0,RW)

MC_TestModelFilter_Hist3dVirtDepthMax 

Max value for depth histogram (double,[MC_TestModelFilter_Hist3dVirtDepthMin,-]:11,RW)

MC_TestModelFilter_dHist3dCommonPartThreshold 

Common part threshold (double,[0.0,1.0]:0.5,RW)

MC_Callback_Registered 

Register the metric calibration callback function (unsigned,[0,1]:0,RO)

MC_ModelPointStep 

Distance of points in the model (double,[0.0,-]:2.0,RW)

MC_InitialFocalLengthMM 

Initial focal length (double,-:100.0,RW)

MC_InitialTotalFocusDistanceMM 

Initial total focus distance (unsigned,-:500.0,RW)

MC_CalibrationResult 

The result of the last metric calibration (enum,Rx::ApiLF::EMetricCalibResult:None,RO)

MC_TargetZDistanceMM 

The known Z-Distance of the Dot-Target starting with 0 and following from that with relative steps. (double,[0.000000,-]:0.000000,RW)

ImgStack_StackingEnabled 

Image Stacking Pars Image stacking enabled (unsigned,[0,1]:0, RW).

ImgStack_StackCount 

Number of images to stack (unsigned,[1,1000]:4, RW).

ImgStack_StackingOperation 

The image stacking operation (unsigned,Rx::EImageStackingOperation:Mean RW).

Parameter Data Type.

Enumerator
RxParTyp_None 

Undefined.

RxParTyp_Int 

Integer

RxParTyp_UInt 

Unsigned integer

RxParTyp_Float 

Float

RxParTyp_String 

String

RxParTyp_ArrayInt 

Array of integers

RxParTyp_ArrayUInt 

Array of unsigned integers

RxParTyp_ArrayFloat 

Array of floats

RxParTyp_ArrayString 

Array of strings

Parameter group IDs.

Enumerator
None 
Cuda 

CUDA parameter group.

Camera 

Camera parameter group.

CamCap 

Camera capture parameter group.

Ray 

Ray image parameter group.

RaySeq 

Ray sequence parameters.

PreProc 

PreProcessing parameter group.

Depth 

Depth evaluation parameter group.

Depth_Path 

Depth Path algorithm.

Focus 

Focus evaluation parameter group.

Grid 

Grid display parameter group.

Projection 

Projection parameter group.

MLA 

MLA parameter group.

MC 

Metric calibration parameter group.

Gray 

Gray image capturing properties.

PIV particle descriptor types. These enums describe the type of descriptor used for sub-pixel refinement (gauss,sphere...)

Enumerator
Invalid 

Particle type not set.

Gauss 

Particle represented as Gaussian.

Sphere 

Particle represented as half-sphere.

Ellipse 

Particle represented as half-ellipse (x/y-radius + orientation)

Gauss2D 

Particle represented as 2D Gaussian (x/y-radius + orientation)

PIV particle rejection causes. These enums provide information on the cause of rejection. Valid particles have cause 'None'.

Enumerator
None 

Particle not rejected during detection.

Radius 

Particle rejected due to invalid radius (not in range given in config)

Occlusion 

Particle rejected due to occlusion with other particle(s)

Divergence 

Particle rejected due to failed descriptor estimation.

LensRadius 

Particle rejected due to out of valid lens radius.

Projection type that can be used with parameter EPar::Projection_Type.

Enumerator
Standard 

The currently used projection system - defined as the standard projection system.

Radial image distortion types.

Enumerator
Constant 

No radial distortion.

Polynom4 

Radial distortion with polynomial of degree 4.

Inversion2 

Radial distortion with inversion of degree 2.

Ray sequence file modes. These enums can be used as a bit mask to combine various modes.

Enumerator
None 

Empty ray sequence mode.

Read 

A ray sequence opened for reading.

Write 

A ray sequence opened for writing.

Compress_Zip 

When writing to a ray sequence, compress frames with zip compression.

Values that represent the space for the projection system.

Enumerator
Virtual 

Scene considered from the perspective of the virtual space (Space 2 (perspective))

Reserved 

Scene considered from the perspective of the undistorted virtual space (Space 3 (perspective))

Object 

Scene considered from the perspective of the object space (Space 4 (orthographic))

ViewCamera 

Scene considered from the perspective of a virtual pinhole camera (Space 5 (perspective))

VirtualPixel 

An enum constant representing the virtual pixel option.

Describes the mapping of the value.

Enumerator
RelativeToVirtual 

Relative to virtual units ([0.0,1.0] –> vd)

RelativeToMetric 

Relative to metric units ([0.0,1.0] –> mm)

VirtualToObjectSpace 

Relative to metric units in the object space (see Rx::Projection::ESpace) (vd –> mm)

VirtualToPinholeCamera 

Relative to metric units in the view camera space (see Rx::Projection::ESpace) (vd –> mm)

MetricToVirtual 

Metric to virtual units (mm –> vd)

Values that represent the space for the projection system.

Enumerator
None 

No feature.

Standard 

Test whether a dongle is present. Check with RxHasFeature().

MultiView 

Multiview feature. All functions that allow the generation of images from different viewpoints only run if this feature is enabled.

FocusOnSurface 

Focus on surface. All functions that use a focus surface to generate an output are only available if this feature is enabled.

Calculate3D 

Calculate 3D depth. All functions that evaluate the scene depth are only available if this feature is enabled.

Calibrate 

Calibration. All functions that modify the calibration of a light field or a Raytrix camera are only available if this feature is enabled.

SDK 

SDK feature. This feature must be enabled to allow SDK usage.

Save 

Save images. All functions that save a light field image are only available if this feature is enabled.

DistributorDemo 

Distributor demo.

Flow 

Flow feature. All functions that a required for evaluating optical flow or PIV.

MetricCalibration 

Metric Calibration feature.

Halcon 

Halcon feature.

Master 

Master feature.