Raytrix Light Field SDK  4.0
Logo
Enumerations
Rx::LFR::Net::Params Namespace Reference

Enumerations

Enumeration Type Documentation

The main parameter enum of the Raytrix ApiLF.

Enumerator
None 
Cam_Count 

Number of cameras available (unsigned,-:-,RO).

RaySeq_AutoStoreCamFrames 

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

ImgStack_StackingEnabled 

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

ImgStack_StackCount 

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

Values that represent calibration parameters.

Enumerator
None 
ViewingFrustumSpace2Type 

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

IsMasterCalibrated 

Is true if the camera has been master calibrated. Must be set after master calibration (unsigned,[0,1]:0,RW).

IsMetricCalibrated 

Is true if the camera has been metric calibrated (unsigned,[0,1]:0,RO).

CollimationPlaneVD 

An enum constant representing the light field collimation plane in VD (double,[-,-]:4,RW).

CollimationPlaneMM_Object_Reference 

An enum constant representing the light field collimation plane in MM in the reference frame (double,[-,-]:[4 projected into the object space in the reference frame],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,[-,-]:500.0,RW).

MainLensThick_Magnification 

The magnification described by the used main lens (double,[0,1e9]: 0.38196601125010515179541316563436, RW).

MainLensThick_NominalFocalLengthMM 

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

MainLensThick_NominalFocusDistanceMM 

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

MainLensThick_NominalMagnification 

The nominal magnification described by the used main lens (double,[0,1e9]: 0.38196601125010515179541316563436, 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_s 

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]:0.09,RW).

ViewCam_Pinhole_ViewOffsetMM_g 

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).

ViewCam_Pinhole_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).

ViewCam_Pinhole_LandscapeMode 

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

ViewCam_Pinhole_SensorScaling 

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

ViewCam_Pinhole_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).

ViewCam_Pinhole_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).

ViewCam_Pinhole_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).

Transformation_Global_Sensor 

This describes the transformation from the global frame to the sensor frame: The first three entries are the translation and the following nine entries are the rotation (row wise) (double[12],[-1.0,1.0]:(0.0,0.0,0.0,1.0,0.0,0.0,0.0,1.0,0.0,0.0,0.0,1.0),RW).

RefPlane_Position 

This describes the transformation from the global frame to the reference frame: The first three entries are the translation and the following nine entries are the rotation (row wise) (double[12],[-1.0,1.0]:(0.0,0.0,0.0,1.0,0.0,0.0,0.0,1.0,0.0,0.0,0.0,1.0),RW).

RefPlane_Position_FromPoints 

This parameter allows the setting of the reference to global transformation with 3 points picked in the reference plane to be. (double[9],[-,-]:-,WO).

RefPlane_ZOffsetToTCP 

This parameter allows the adjusting of the reference plane position, by translating the reference plane along its z axis relative to the TCP origin. (double,[-,-]:-,RW).

MLA_NominalLensPitchPX 

The nominal MLA lens pitch in pixels. This is the distance between neighboring micro lens centers. The nominal lens pitch serves as an initial start for further more precise calibrations. This sets the automatically computed homography (double,[0.0,-]:23.0,RW).

MLA_NominalCenterPX_pxa 

The nominal MLA center in pixels on PXA (double[2],[-,-]:(0.0,0.0),RW).

MLA_NominalCenterPX_screen 

The nominal MLA center in pixels on screen frame (double[2],[-,-]:-,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_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_LensTypeCount 

Number of micro lens types on the MLA (unsigned,[0,12]:-,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_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,-]:-,RO).

MLA_IsMlaDistanceConfigured 

Is true if the camera's MLA to sensor distance has been configured and must not be changed. Must be set after configuration of the true nominal MLA to sensor distances of the physical MLA. Setting this property copies the nominal MLA to sensor distance to calibrated MLA to sensor distance. (unsigned,[0,1]:0,RW).

MLA_NominalSensorDistanceToLensType1MM 

The nominal orthogonal distance between the micro-lenses of type 1 to the sensor. This may be different for each micro lens type. The values are given in millimeters (MM). This parameter describes the Length of 1VD in MM. (double,[> 0,-]:-,RW)

MLA_LensTypeOffsetsToLensType1VD 

The normalized offsets of lens type 0 and 2 to lens type 1. To calculate the Mla to sensor distances in MM for 0, 1 or 2: double dMlaToSensorDistance0MM = (1 + vdLensTypeOffsetsToLensType1VD.x) * dSensorDistanceToLensType1MM; double dMlaToSensorDistance1MM = dSensorDistanceToLensType1MM; double dMlaToSensorDistance2MM = (1 + vdLensTypeOffsetsToLensType1VD.y) * dSensorDistanceToLensType1MM; (double[2],[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,-]:-,RO).

MLA_IsAutoCalibrated 

Is true if this MLA has been calibrated automatically. (unsigned,[0,1]:0,RO).

MLA_SensorDistanceToLensType1MM 

The orthogonal distance between the micro-lenses of type 1 to the sensor. This may be different for each micro lens type. The values are given in millimeters (MM). This parameter describes the Length of 1VD in MM.(double,[> 0,-]:-,RW)

MLI_ManualLensPitchPX 

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

MLI_ManualCenterPX_pxa 

The MLI center in pixels on PXA (double[2],[0.0,-]:0.0,RW).

MLI_ManualCenterPX_s 

The MLI center in pixels on sensor frame (double[2],[0.0,-]:-,RW).

MLI_ManualRotationRAD 

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

MLI_BorderLU 

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

MLI_LensGapPX 

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

MLI_LensBorderPX 

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

MLI_IsCalibrated 

Is true if this MLI has been calibrated manually or automatically (unsigned,[0,1]:0,RO).

MLI_IsAutoCalibrated 

Is true if this MLI has been calibrated automatically. The manual MLI parameters aren't used (unsigned,[0,1]:0,RO).

MLI_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,[-,-]:0.0,RO).

MLI_FocusEffectiveMinMM_ObjectSpace 

Minimal mm in object space 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).

Values that represent capture gray image parameters.

Enumerator
None 
NumberOfImages 

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

DelayBetweenImages 

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

Values that represent CUDA compute parameters.

Enumerator
None 
PreProc_Std_Enable 

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).

PreProc_DataType 

The data type of all resultant images. Supported data types are UByte (unsigned char) and UShort (unsigned short). If set to Void, the data type is the same as the input raw image. (enum,[Rx::Interop::Runtime28::EDataType]:UShort,RW).

Depth_ImageDivisor 

Result image size divisor for depth evaluation (double,[2.0,20.0]:4.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).

Depth_NearResolutionLevel 

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

Depth_SparseLensSet 

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

Depth_MinStdDeviation 

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

Depth_MinCorrelation 

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

Depth_PatchDiameter 

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

Depth_PatchStride 

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

Depth_LensFilterMask 

A lens filter mask to disable (1) or enable (0) certain lens types during depth estimation (unsigned[12],[0,1]:0,RW).

Depth_ConsistencyCheck 

Enable (1) or disable (0) a depth consistency check while creating the depth map. This check should always be enabled (unsigned,[0,1]:1,RW).

Depth_Algorithm 

The algorithm used for depth estimation. (0) is the default depth path algorithm. (1) is the slower ray cast algorithm (unsigned,[0,1]:0,RW).

Depth_Correction_A 

Depth correction A (double,[,]:0,RW).

Depth_Fill_Enabled 

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,20]: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],0,RW).

Depth_Fill_Bilateral_Enabled 

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

Depth_Fill_Bilateral_FilterRadius 

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

Depth_Fill_Bilateral_Edge 

Bilateral filter edge threshold (double,[0.01,0.2]:0.05,RW).

Depth_Fill_Bilateral_Range 

Bilateral filter range distance threshold (double,[1.0,20.0]:5.0,RW).

Depth_Fill_Filter_Enabled 

Flag to indicate whether the first 3 iterations of the filling algorithm should perform an implicit filtering (unsigned,[0,1]:1,RW).

Depth_Fill_Algorithm 

The algorithm used for depth filling. (0) is the default depth filling algorithm. (1) is the slower depth fill algorithm that considers more image information. (unsigned,[0,1]:0,RW).

Depth_Fill_MaxColorSimilarity 

When the color difference of two compared pixels exceeds this threshold, the pixel is skipped. The difference is referred to normalized values where 1 would be a difference of 255 luminance values.

Depth_Fill_ShrinkRangePX 

Shrinks the depth map 'contour' by removing all valid depths that are in this range (given in pixels) of an invalid depth value. A value of 0 means no shrink (unsigned,[0,100]:0,RW).

Focus_ImageDivisor 

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

Focus_RelativeFocusPlane 

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

Focus_DepthBlendingScale 

This scale is used to blend the colored depth image with the focus image (double,[0.0,1.0]:0.0,RW).

Multiview_Type 

Multiview type (enum,[Rx::EMultiView]:Rx::EMultiView::RedCyan,RW).

Multiview_EyeSeparation 

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

Grid_DrawOnGrayImage 

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

Grid_DrawMlaGrid 

If set to 1U, the grid is drawn with MLA calibration instead of MLI calibration (unsigned,[0,1]:0,RW).

DepthMap_Color_Mode 

The color mode (enum,[EColorMode]:EColorMode::Manual,RW).

DepthMap_Color_Min 

The minimum color value given in millimeters in reference frame (double,[-,-]:0,RW).

DepthMap_Color_Max 

The maximum color value given in millimeters in reference frame (double,[-,-]:10,RW).

DepthMap_Color_Map 

Specifies the color map used to color the depth map (enum,[EColorMap]:EColorMap::Perceptually_Uniform_Rainbow,RW).

Values that represent Cuda device parameters.

Enumerator
None 
Name 

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

DeviceID 

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

ComputeCapabilityMajor 

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

ComputeCapabilityMinor 

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

TotalGlobalMemoryMB 

CUDA device total global memory in MB (double,-:-,RO).

TotalConstMemoryMB 

CUDA device total constant memory in MB (double,-:-,RO).

RegistersPerBlock 

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

WarpSize 

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

MemPitchMB 

CUDA device memory pitch in MB (double,-:-,RO).

MaxThreadsPerBlock 

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

DeviceOverlap 

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

MultiProcessorCount 

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

ComputeMode 

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

MaxTex2DSizeX 

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

MaxTex2DSizeY 

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

MaxTex2DArraySizeX 

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

MaxTex2DArraySizeY 

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

ConcurrentKernels 

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

TCCDriver 

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

ClockFrequencyMHz 

The clock frequency of the CUDA device in kilohertz (double,-:-,RO).

KernelExecTimeoutEnabled 

Specified whether there is a run time limit on kernels (unsigned,-:-,RO).

PCIBusID 

PCI bus ID of the device (unsigned,-:-,RO).

Values that represent parameter groups.

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.

Grid_Calibration 

Grid calibration parameter group.

Projection 

Projection parameter group.

MLA 

MLA parameter group.

MC 

Metric calibration parameter group.

Gray 

Gray image capturing properties.

LF_Camera 

The light field camera.

MlaCalibration 

The Mla calibration parameter group.

ParticleTracking 

The particle tracking parameter group.

SuperResolution 

The Super resolution parameter group.

HighResolutionParticleDetector 

The high resolution particle detector parameter group

Values that represent high resolution particle detector parameters.

Enumerator
None 
FD_InititalVariance 
FD_MinMaxRatio 

Feature detector: Ratio of pixels that have to be smaller pixel value to accept position as maximum. Evaluation area is given by uiHalfWinsizeMinMaxRatio (double,[0,-]:0.8,RW).

FD_HalfWinsizeMinMaxRatio 

Feature detector: Half window size to determine maximum ratio.(unsigned,[1,-]:2,RW)

FD_HalfWinsizeMaxCluster 

Feature detector: Half window size to cluster maxima. Maxima within window around active pixel are considered to be the same maximum. (unsigned,[1,-]:2,RW)

FD_HalfPatchSize 

Feature detector: Size of the patch image.(unsigned,[1,-]:10,RW)

Depth_MinCorrelation 

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

Depth_MinStdDeviation 

Depth: Minimal standard deviation of correlation patch (double,[0.0,1.0]:0.01,RW).

Depth_PatchSize 

Depth correlation patch size (unsigned,[2,5]:5,RW).

SRScale 

Super Resolution: The upscaling factor. (unsigned,[2,20]:2, RW).

SRPatchRadius 

Super Resolution: The radius of the source patch.(unsigned,[2,-]:6, RW)

SRIterations 

The number of iterations of the super resolution algorithm. (unsigned,[1,200]:1, RW).

SRFilterMinVdLens1 

Super Resolution: The lower bound for source patches of lens type 1, that are used for super resolution regarding virtual depth. (double,[0.0,100.0]:1.0,RW)

SRFilterMaxVdLens1 

Super Resolution: The upper bound for source patches of lens type 1, that are used for super resolution regarding virtual depth. (double,[0.0,100.0]:3.0,RW)

SRFilterMinVdLens2 

Super Resolution: The lower bound for source patches of lens type 2, that are used for super resolution regarding virtual depth. (double,[0.0,100.0]:2.0,RW)

SRFilterMaxVdLens2 

Super Resolution: The upper bound for source patches of lens type 2, that are used for super resolution regarding virtual depth. (double,[0.0,100.0]:4.0,RW)

SRFilterMinVdLens3 

Super Resolution: The lower bound for source patches of lens type 3, that are used for super resolution regarding virtual depth. (double,[0.0,100.0]:3.8,RW)

SRFilterMaxVdLens3 

Super Resolution: The upper bound for source patches of lens type 3, that are used for super resolution regarding virtual depth. (double,[0.0,100.0]:100.0,RW)

SRMinLensBorderDistance 

Super Resolution: Min lens border distance. (unsigned,[0,-]:3,RW)

FD_MaxFeaturesPerDetection 
FD_FeatureQuality 
FD_MinDistance 
FD_PatchSize 
FD_StrongFeaturesOnly 
FD_Strongness 
MinMotionParticleMM 
MaxMotionParticleMM 
MaxDepthMotionParticleMM 
MinMotionAngleDegree 
MinSpanTrackMM 
ParticleSimilarityMM_s 
ParticleSimilarityColorPercentage 
MaxMotionDifferencePercentage 
TrusworthyTrack 
MinTrackLength 
MainFluidOrientation 

Values that represent metric calibration parameter.

Enumerator
None 
Enable_StoreRefocusedImage 

Store the refocused image (unsigned,[0,1]:0,RW).

Enable_FocalLength 

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

Enable_OpticalAxis 

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

Enable_PrinciplePoint 

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

Enable_MLAToSensorDistance 

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

Enable_Dist_Center 

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

Enable_RadialPolyConst 

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

Enable_RadialPoly 

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

Enable_DepthPoly 

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

Enable_AxialPoly 

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

Enable_DataOutput 

Flag for data output. This comprises information of the added images and their resultant models (planar and test). The calibration log, depth (intermediate) images and image sequence. (unsigned,[0,1]:0,RW).

CalibrationIterationCount 

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

TestModelFilter_SmoothRadius 

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

TestModelFilter_MaxOutlierPointsPercentage 

Maximal number of point outliers that can be filtered. Test models with more outliers points are not filtered. (double,[0.0,1.0]:0.1,RW).

TestModelFilter_DepthStdDevThresholdVD 

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

TestModelFilter_Hist3dHorizBinCount 

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

TestModelFilter_Hist3dDepthBinCount 

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

TestModelFilter_Hist3dVirtDepthMin 

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

TestModelFilter_Hist3dVirtDepthMax 

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

TestModelFilter_dHist3dCommonPartThreshold 

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

Callback_Registered 

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

ModelPointStep 

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

InitialFocalLengthMM 

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

InitialTotalFocusDistanceMM 

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

CalibrationResult 

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

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).

DataOutputPath 

The export path for the additional output. (string,[-,-]:-,RW).

Values that represent MLA calibration parameters.

Enumerator
None 
Depth_PatchDiameter 

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

Depth_PatchStride 

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

Depth_NumberOfPaths 

Number of paths per depth path job. Values: (unsigned,[1,2]:1,RW).

Depth_MinCorrelation 

Minimal correlation threshold (double,[0.0,1.0]:0.88,RW).

Depth_MinVariance 

The minimum variance. (double,[0.0,1.0]: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).

Depth_UsePolynomialFit 

True to use a polynomial fit to find the best correlation between two match points.(unsigned, [0,1]:1, RW).

Depth_LensFilterMask 

A lens filter mask to disable (1) or enable (0) certain lens types during depth estimation (unsigned[12],[0,1]:0,RW).

Algorithm_IterationCount 

Number of calibration iterations (unsigned,[1,-]:5,RW).

Algorithm_ErrorStopCriterion 

If the error reached its stop criterion the calibration is aborted. (double,[0.0,1.0]:1e-6,RW).

Algorithm_InnerImagePartPercentage 

The inner part in percentage that should be used to calibrate the MLA. (unsigned, [0,100]:95, RW).

Algorithm_PixelStep 

The pixel step in which the ROI should be sampled.(unsigned, [1,-]:1, RW).

Algorithm_MlaScaleFactor 

The MLA scale factor. (double,[0.0,1.0]:1.0,RW)

Algorithm_UseLinearInterpolationForReferenceDepth 

true to use linear interpolation for reference depth (unsigned, [0,1]:1, RW).

Algorithm_UseMedian 

true to use the median for the offset calculation (Within the algorithm and the final end outcome), false to use mean (unsigned, [0,1]:1, RW).

WriteDebugData 

true to write debug data to DebugOutputPath (unsigned, [0,1]:0, RW).

DebugOutputPath 

Full base pathname of the debug output files. (string,[-,-]:-,RW)

Values that represent particle tracking parameter.

Enumerator
None 
Misc_ProcessCount 

Number of processes used for 2D particle detection and time tracking.

Misc_WorkingDirectory 

Base filename for temporary particle data swap.

Misc_SequenceStartImage 

0-based frame index in sequence to start processing.

Misc_SequenceStopImage 

0-based frame index in sequence to stop processing.

Misc_ImageRegion_MinX 

Minimum x-component in image region to process (Region of Interest).

Misc_ImageRegion_MinY 

Minimum y-component in image region to process (Region of Interest).

Misc_ImageRegion_MaxX 

Maximum x-component in image region to process (Region of Interest). 0U to use full image width.

Misc_ImageRegion_MaxY 

Maximum y-component in image region to process (Region of Interest). 0U to use full image height.

Misc_UseLensTypeFar 

1U to use lens type far, 0U to omit.

Misc_UseLensTypeMiddle 

1U to use lens type middle, 0U to omit.

Misc_UseLensTypeNear 

1U to use lens type near, 0U to omit.

ImageProc_ParticleDensity 

The particle density setting used in 2D particle detection. Trade off between uniqueness of particles and runtime. 0U : only few particles in whole image. Exhaustive computational effort for moderate or higher particle count 1U : only single particles in each lens. Exhaustive computational effort for high particle count 2U : multiple particles per lens over large parts of the image. Least effort, possible multi detection of particles

ImageProc_MinParticleRadiusPX 

The minimum particle radius constraint for 2D particle detection. [0.1 ... 20]

ImageProc_MaxParticleRadiusPX 

The maximum particle radius constraint for 2D particle detection. [0.1 ... 20]

ImageProc_MinParticleBrightness 
ImageProc_MaxParticlesPerLens 

The maximum particles per lens constraint for 2D particle detection. Lenses with more 2D particles are not used in 3D estimation.

ImageProc_UseProcessedImage 

1U to use processed image instead of raw image for particle detection.

ImageProc_UseBackgroundImage 

1U to use background image subtraction. An BG image has to be available.

ImageProc_BackgroundImageStartIndex 

0-based start index for BG image computation.

ImageProc_BackgroundImageStopIndex 

0-based stop index for BG image computation.

Tracking_UseVisualTimeTracking 

Set 1U to use radius and scale of particles for time matching instead of nearest neighbor.

Tracking_ImageTimeDelta 

The time delta for velocity estimation (in PIV mode the double-shoot delay).

Tracking_PivMode 

1U : Time matching only for succeeding image pairs (1 to 2 ; 3 to 4 ...).

Depth_MaxEpilineDistancePX 

The maximum epipolar line distance constraint for 2D particle grouping.

Values that represent super resolution parameters.

Enumerator
None 
Scale 

The super resolution scale. (unsigned,[2,20]:3, RW).

Iterations 

The number of iterations of the super resolution algorithm. (unsigned,[1,200]:20, RW).

TemporalRadius 

Radius of the temporal search area. Where 0 sets the algorithm to automatic mode. (unsigned,[0,-]:0, RW).

OpticalFlowAlgorithm 

An enum constant representing the optical flow algorithm option. (enum,[Rx::EOpticalFlowType]:Rx::EOpticalFlowType::Farneback,RW).