Light Field Parameter API functions

Functions to get/set API parameters. More...

Functions
RXLF_API void	Rx::ApiLF::RxGetPar (EPar::ID ePar, unsigned &uValue)
	Get a parameter of type unsigned integer. More...
RXLF_API void	Rx::ApiLF::RxGetPar (EPar::ID ePar, double &dValue)
	Get a parameter of type double. More...
RXLF_API void	Rx::ApiLF::RxGetPar (EPar::ID ePar, Rx::CRxString &sValue)
	Get a parameter of type Rx::CRxString. More...
RXLF_API void	Rx::ApiLF::RxGetPar (EPar::ID ePar, Rx::CRxArrayUInt &aValue)
	Get Parameter of type CRxArrayUInt. More...
RXLF_API void	Rx::ApiLF::RxGetPar (EPar::ID ePar, Rx::CRxArrayDouble &aValue)
	Get Parameter of type CRxArrayDouble. More...
RXLF_API void	Rx::ApiLF::RxGetPar (EPar::ID ePar, Rx::CRxArrayString &aValue)
	Get Parameter of type CRxArrayString. More...
RXLF_API void	Rx::ApiLF::RxGetPar (EPar::ID ePar, const unsigned uIndex, unsigned &uValue)
	Get Parameter of type unsigned int.This function is related to the overloaded function RxGetPar(EPar::ID ePar, Rx::CRxArrayUInt aValue) and will return the Value of the parameter array on given index. More...
RXLF_API void	Rx::ApiLF::RxGetPar (EPar::ID ePar, const unsigned uIndex, double &dValue)
	Get Parameter of type unsigned int. This function is related to the overloaded function RxGetPar(EPar::ID ePar, Rx::CRxArrayDouble aValue) and will return the Value of the parameter array on given index. More...
RXLF_API void	Rx::ApiLF::RxGetPar (EPar::ID ePar, const unsigned uIndex, Rx::CRxString &sValue)
	Get Parameter of type unsigned int. This function is related to the overloaded function RxGetPar(EPar::ID ePar, Rx::CRxArrayString aValue) and will return the Value of the parameter array on given index. More...
RXLF_API void	Rx::ApiLF::RxGetParName (EPar::ID ePar, Rx::CRxString &sValue)
	Get the string representation of a parameter. More...
RXLF_API void	Rx::ApiLF::RxGetParProperties (EPar::ID ePar, Rx::CRxString &sValue, bool &bReadAccess, bool &bWriteAccess, EParameterDataType::ID &eParameterType)
	Get the Properties of a parameter. More...
RXLF_API void	Rx::ApiLF::RxGetParRange (EPar::ID ePar, unsigned &uMin, unsigned &uMax)
	Get the range of a parameter. More...
RXLF_API void	Rx::ApiLF::RxGetParRange (EPar::ID ePar, double &dMin, double &dMax)
	Get the range of a parameter. More...
RXLF_API void	Rx::ApiLF::RxGetParRange (EPar::ID ePar, size_t &iArrayLenMin, size_t &iArrayLenMax, unsigned &uMin, unsigned &uMax)
	Get the range of a parameter. Some array-based parameter have a dynamic array size. The parameter iArrayLenMin and iArrayLenMax returns the allowed length of the array on a zero based index. More...
RXLF_API void	Rx::ApiLF::RxGetParRange (EPar::ID ePar, size_t &iArrayLenMin, size_t &iArrayLenMax, double &uMin, double &uMax)
	Get the range of a parameter. Some array-based parameter have a dynamic array size. The parameter iArrayLenMin and iArrayLenMax returns the allowed length of the array on a zero based index. More...
RXLF_API void	Rx::ApiLF::RxLoadParameter (const Rx::CRxString &sxFilename)
	Loads all writable API parameter from file. Its mandatory to bind a light field image before. More...
RXLF_API void	Rx::ApiLF::RxSaveParameter (const Rx::CRxString &sxFilename)
	Saves all writable API parameter to file. Its mandatory to bind a light field image before. More...
RXLF_API void	Rx::ApiLF::RxSetPar (EPar::ID ePar, const unsigned &uValue)
	Set a parameter of type unsigned integer. More...
RXLF_API void	Rx::ApiLF::RxSetPar (EPar::ID ePar, const double &dValue)
	Set a parameter of type double. More...
RXLF_API void	Rx::ApiLF::RxSetPar (EPar::ID ePar, const Rx::CRxString &sValue)
	Set a parameter of type Rx::CRxString. More...
RXLF_API void	Rx::ApiLF::RxSetPar (EPar::ID ePar, const Rx::CRxArrayUInt &aValue)
	Set a parameter of typeRx::CRxArrayUInt. More...
RXLF_API void	Rx::ApiLF::RxSetPar (EPar::ID ePar, const Rx::CRxArrayDouble &aValue)
	Set a parameter of type Rx::CRxArrayDouble. More...
RXLF_API void	Rx::ApiLF::RxSetPar (EPar::ID ePar, const Rx::CRxArrayString &aValue)
	Set a parameter of type Rx::CRxArrayString. More...
RXLF_API void	Rx::ApiLF::RxSetPar (EPar::ID ePar, const unsigned uIndex, const unsigned &uValue)
	Set a Parameter of type unsiged. This function is related to void Rx::ApiLF::RxSetPar(Rx::ApiLF::EPar::ID ePar,const Rx::CRxArrayUInt aValue) and sets the Value of the array on the given index. More...
RXLF_API void	Rx::ApiLF::RxSetPar (EPar::ID ePar, const unsigned uIndex, const double &dValue)
	Set a Parameter of type unsiged. This function is related to void Rx::ApiLF::RxSetPar(EPar::ID ePar, const Rx::CRxArrayDouble& aValue) and sets the Value of the array on the given index. More...
RXLF_API void	Rx::ApiLF::RxSetPar (EPar::ID ePar, const unsigned uIndex, const Rx::CRxString &sValue)
	Set a Parameter of type unsiged. This function is related to void Rx::ApiLF::RxSetPar(EPar::ID ePar, const Rx::CRxArrayString& aValue) and sets the Value of the array on the given index. More...

Detailed Description

Functions to get/set API parameters.

With these functions parameters of the API can be read and set. The parameter IDs are defined in Rx::ApiLF::EPar. Note that the parameters starting with Rx::ApiLF::EPar::Cam_ and Rx::ApiLF::EPar::CamCal_ have to be read and set with Rx::ApiLF::RxCamGetPar and Rx::ApiLF::RxCamSetPar, with the exeception of Rx::ApiLF::EPar::Cam_Count. The parameters are grouped in the following categories:

• Rx::ApiLF::EPar::Cuda_*: CUDA device
• Rx::ApiLF::EPar::Cam_*: Camera
• Rx::ApiLF::EPar::CamCap*: Camera calibration
• Rx::ApiLF::EPar::Ray_*: Ray image
• Rx::ApiLF::EPar::RaySeq_*: Ray Sequence
• Rx::ApiLF::EPar::Gl_*: CUDA/OpenGL interop
• Rx::ApiLF::EPar::PreProc*: Pre-processing
• Rx::ApiLF::EPar::Depth_*: Depth evaluation algorithms
• Rx::ApiLF::EPar::Focus_*: Refocus algorithm
• Rx::ApiLF::EPar::Proj_*: Projection parameter
• Rx::ApiLF::EPar::Sensor_*: Sensor parameter
• Rx::ApiLF::EPar::VirtCamPinholeStd_*: Virtual camera
• Rx::ApiLF::EPar::MainLens_*: main lens
• Rx::ApiLF::EPar::Mla_*: mla
• Rx::ApiLF::EPar::MC_*: Metric calibration

Attention

Getting and setting of camera parameter demands a bound camera.

Function Documentation

RXLF_API void Rx::ApiLF::RxGetPar	(	EPar::ID	ePar,
		unsigned &	uValue
	)

Get a parameter of type unsigned integer.

Warning

If the parameter referenced by ePar does not relate to an unsigned parameter an Rx::ApiLF::CRxApiException is thrown.

Halcon Plugin - Function Name:

rx_get_par_int

Parameters

	ePar	The parameter ID. Allowed enum values are: Cuda Rx::ApiLF::EPar::Cuda_DeviceID Rx::ApiLF::EPar::Cuda_CapaMajor Rx::ApiLF::EPar::Cuda_VersionRuntime Rx::ApiLF::EPar::Cuda_VersionDriver Rx::ApiLF::EPar::Cuda_TotalGlobalMem Rx::ApiLF::EPar::Cuda_WarpSize Rx::ApiLF::EPar::Cuda_MemPitch Rx::ApiLF::EPar::Cuda_MaxThreadsPerBlock Rx::ApiLF::EPar::Cuda_TotalConstMem Rx::ApiLF::EPar::Cuda_DeviceOverlap Rx::ApiLF::EPar::Cuda_MultiProcessorCount Rx::ApiLF::EPar::Cuda_ComputeMode Rx::ApiLF::EPar::Cuda_MaxTex2DSizeX Rx::ApiLF::EPar::Cuda_MaxTex2DSizeY Rx::ApiLF::EPar::Cuda_MaxTex2DArraySizeX Rx::ApiLF::EPar::Cuda_MaxTex2DArraySizeY Rx::ApiLF::EPar::Cuda_ConcurrentKernels Rx::ApiLF::EPar::Cuda_TCCDriver Bound Ray Image Rx::ApiLF::EPar::Ray_Width Rx::ApiLF::EPar::Ray_Height Rx::ApiLF::EPar::Ray_PixelType Rx::ApiLF::EPar::Ray_DataType Rx::ApiLF::EPar::Ray_ApplyWhiteImage Rx::ApiLF::EPar::Ray_ConvBayer Rx::ApiLF::EPar::Ray_ApplyFileSettings Ray Sequence Rx::ApiLF::EPar::RaySeq_AutoStoreCamFrames Rx::ApiLF::EPar::RaySeq_ApplyFileSettings Rx::ApiLF::EPar::RaySeq_AutoStoreCamFrameCnt Ray PreProcess Algorithm Rx::ApiLF::EPar::PreProc_Std_Enable Rx::ApiLF::EPar::PreProc_Sharp1_Enable Rx::ApiLF::EPar::PreProc_Sharp1_OnlyCalc Rx::ApiLF::EPar::PreProc_Demosaic_Enable Rx::ApiLF::EPar::PreProc_DenoiseNLM_Enable Rx::ApiLF::EPar::PreProc_DenoiseNLM_FilterDia Depth Algorithm Rx::ApiLF::EPar::Depth3D_UseVirtualDepth Depth Path Algorithm Rx::ApiLF::EPar::Depth_Path_BlockCnt Rx::ApiLF::EPar::Depth_Path_NearResLevel Rx::ApiLF::EPar::Depth_Path_SparseLensSet Depth Fuse Direct Algorithm Rx::ApiLF::EPar::Depth_Fuse_MedianRad Rx::ApiLF::EPar::Depth_Fuse_MeanRad Depth Fill Algorithm Rx::ApiLF::EPar::Depth_Fill_Enabled Rx::ApiLF::EPar::Depth_Fill_IterCnt Rx::ApiLF::EPar::Depth_Fill_IterSize Rx::ApiLF::EPar::Depth_Fill_Complete Rx::ApiLF::EPar::Depth_Fill_Median_Enabled Rx::ApiLF::EPar::Depth_Fill_Median_Radius Rx::ApiLF::EPar::Depth_Fill_Mean_Enabled Rx::ApiLF::EPar::Depth_Fill_Mean_Radius Rx::ApiLF::EPar::Depth_Fill_NLM_Enabled Rx::ApiLF::EPar::Depth_Fill_NLM_FilterDia Rx::ApiLF::EPar::Depth_Fill_Bilateral_Enabled Rx::ApiLF::EPar::Depth_Fill_Bilateral_FilterRad Projection Rx::ApiLF::EPar::Proj_Type Rx::ApiLF::EPar::Proj_ViewingFrustumSpace2Type Rx::ApiLF::EPar::Proj_DepthPlanesAuto Rx::ApiLF::EPar::Proj_CurrentTargetView Virtual Camera Rx::ApiLF::EPar::VirtCamPinholeStd_LandscapeMode Rx::ApiLF::EPar::VirtCamPinholeStd_SensorScaling MLA Rx::ApiLF::EPar::Mla_LensTypeCount Rx::ApiLF::EPar::Mla_InvertAxisX Rx::ApiLF::EPar::Mla_InvertAxisY Rx::ApiLF::EPar::Mla_Rotation90Count MLA Image Distortion Rx::ApiLF::EPar::MlaImg_RadialDistType Rx::ApiLF::EPar::MlaImg_RadialDistParamCount Rx::ApiLF::EPar::MlaImg_HasParallelLightCalib Rx::ApiLF::EPar::MlaImg_CalibType Stereo Rx::ApiLF::EPar::Stereo_Type Defocus Blur Rx::ApiLF::EPar::Focus_DefocusBlur_Enable Rx::ApiLF::EPar::Focus_DefocusBlur_MaxBlurRad Grid Algorithm Rx::ApiLF::EPar::Grid_DrawOnWhiteImage Metric Calibration Parameters Rx::ApiLF::EPar::MC_Enable_StoreRefocusedImage Rx::ApiLF::EPar::MC_Enable_FocalLength Rx::ApiLF::EPar::MC_Enable_PrinciplePlaneSeperation Rx::ApiLF::EPar::MC_Enable_OpticalAxis Rx::ApiLF::EPar::MC_Enable_PrinciplePoint Rx::ApiLF::EPar::MC_Enable_MLAToSensorDistance Rx::ApiLF::EPar::MC_Enable_MLALensTypeRatio Rx::ApiLF::EPar::MC_Enable_Dist_Center Rx::ApiLF::EPar::MC_Enable_RadialPolyConst Rx::ApiLF::EPar::MC_Enable_RadialPoly Rx::ApiLF::EPar::MC_Enable_DepthPoly Rx::ApiLF::EPar::MC_Enable_AxialPoly Rx::ApiLF::EPar::MC_CalibrationIterationCount Rx::ApiLF::EPar::MC_TestModelFilter_SmoothRadius Rx::ApiLF::EPar::MC_TestModelFilter_Hist3dHorizBinCount Rx::ApiLF::EPar::MC_TestModelFilter_Hist3dDepthBinCount Rx::ApiLF::EPar::MC_TestModelFilter_MinPointCount Rx::ApiLF::EPar::MC_Callback_Registered Rx::ApiLF::EPar::MC_InitialTotalFocusDistanceMM Rx::ApiLF::EPar::MC_CalibrationResult
[out]	uValue	On return contains the parameter value.

RXLF_API void Rx::ApiLF::RxGetPar	(	EPar::ID	ePar,
		double &	dValue
	)

Get a parameter of type double.

Warning

If the parameter referenced by ePar does not relate to an double parameter an Rx::ApiLF::CRxApiException is thrown.

Halcon Plugin - Function Name:

rx_get_par_float.

Parameters

	ePar	The parameter ID. Allowed enum values are: Ray PreProcess Algorithm Rx::ApiLF::EPar::PreProc_Std_Brightness Rx::ApiLF::EPar::PreProc_Std_ContrastCenter Rx::ApiLF::EPar::PreProc_Std_ContrastScale Rx::ApiLF::EPar::PreProc_Sharp1_BlurStdDev Rx::ApiLF::EPar::PreProc_Sharp1_Factor Rx::ApiLF::EPar::PreProc_Demosaic_R Rx::ApiLF::EPar::PreProc_Demosaic_G Rx::ApiLF::EPar::PreProc_Demosaic_B Rx::ApiLF::EPar::PreProc_DenoiseNLM_NoiseLevel Rx::ApiLF::EPar::PreProc_DenoiseNLM_BlendFactor Depth Algorithm Rx::ApiLF::EPar::Depth_ResImgDiv Rx::ApiLF::EPar::Depth_DefaultValue Depth Path Algorithm Rx::ApiLF::EPar::Depth_Path_MaxVirtDepth Depth Fuse Direct Algorithm Rx::ApiLF::EPar::Depth_Fuse_MeanMaxBlackPart Depth Fill Algorithm Rx::ApiLF::EPar::Depth_Fill_NLM_NoiseLevel Rx::ApiLF::EPar::Depth_Fill_NLM_BlendFactor Rx::ApiLF::EPar::Depth_Fill_Bilateral_Edge Rx::ApiLF::EPar::Depth_Fill_Bilateral_Range Focus Algorithm Rx::ApiLF::EPar::Focus_ResImgDiv Rx::ApiLF::EPar::Focus_MaxLensContribRad Rx::ApiLF::EPar::Focus_RelativeFocusPlane Projection Rx::ApiLF::EPar::Proj_NominalFocusDistanceMM Rx::ApiLF::EPar::Proj_NominalFocalLengthMM Sensor Rx::ApiLF::EPar::Sensor_PhysicalPixelSizeMM Virtual Camera Rx::ApiLF::EPar::VirtCamPinholeStd_ViewZoomFactor Rx::ApiLF::EPar::VirtCamPinholeStd_SensorSizeFactor Rx::ApiLF::EPar::VirtCamPinholeStd_ViewRotationDEG Main Lens Thin Rx::ApiLF::EPar::MainLensThin_FocalLengthMM Rx::ApiLF::EPar::MainLensThin_TotalFocusDistanceMM Main Lens Thick Rx::ApiLF::EPar::MainLensThick_FocalLengthMM Rx::ApiLF::EPar::MainLensThick_TotalFocusDistanceMM Rx::ApiLF::EPar::MainLensThick_PlaneSeparationMM MLA Rx::ApiLF::EPar::Mla_LensPitchMM Rx::ApiLF::EPar::Mla_LensPitchPX Rx::ApiLF::EPar::Mla_LensGapMM Rx::ApiLF::EPar::Mla_LensGapPX Rx::ApiLF::EPar::Mla_LensBorderMM Rx::ApiLF::EPar::Mla_LensBorderPX Rx::ApiLF::EPar::Mla_RotationRad Rx::ApiLF::EPar::Mla_MlaBorderLU Rx::ApiLF::EPar::Mla_NominalLensPitchMM Rx::ApiLF::EPar::Mla_NominalLensPitchPX Stereo Rx::ApiLF::EPar::Stereo_EyeSeparation Defocus Blur Rx::ApiLF::EPar::Focus_DefocusBlur_VirtDOF Rx::ApiLF::EPar::Focus_DefocusBlur_Gradient Rx::ApiLF::EPar::Focus_DefocusBlur_DefaultDepth Metric Calibration Parameters Rx::ApiLF::EPar::MC_TestModelFilter_OutlierThresholdVD Rx::ApiLF::EPar::MC_TestModelFilter_DepthStdDevThresholdVD Rx::ApiLF::EPar::MC_TestModelFilter_Hist3dVirtDepthMin Rx::ApiLF::EPar::MC_TestModelFilter_Hist3dVirtDepthMax Rx::ApiLF::EPar::MC_TestModelFilter_dHist3dCommonPartThreshold Rx::ApiLF::EPar::MC_ModelPointStep Rx::ApiLF::EPar::MC_InitialFocalLengthMM Camera Capture Rx::ApiLF::EPar::CamCap_AutoLum_MaxSaturatedPixelPercentage Rx::ApiLF::EPar::CamCap_AutoExposure_MinValue Rx::ApiLF::EPar::CamCap_AutoExposure_MaxValue
[out]	dValue	On return contains the parameter value.

RXLF_API void Rx::ApiLF::RxGetPar	(	EPar::ID	ePar,
		Rx::CRxString &	sValue
	)

Get a parameter of type Rx::CRxString.

Warning

If the parameter referenced by ePar does not relate to an string parameter an Rx::ApiLF::CRxApiException is thrown.

Halcon Plugin - Function Name:

rx_get_par_string

Parameters

	ePar	The parameter ID. Allowed enum values are: Cuda Rx::ApiLF::EPar::Cuda_DeviceName Depth Algorithm Rx::ApiLF::EPar::Depth_Algo
[out]	sValue	On return contains the parameter value.

RXLF_API void Rx::ApiLF::RxGetPar	(	EPar::ID	ePar,
		Rx::CRxArrayUInt &	aValue
	)

Get Parameter of type CRxArrayUInt.

Warning

If the parameter referenced by ePar does not relate to an Rx::CRxArrayUInt parameter, then an Rx::ApiLF::CRxApiException is thrown.

Parameters

	ePar	The parameter ID. Allowed enum values are: Depth Path Algorithm Rx::ApiLF::EPar::Depth_Path_LT_PatchDia Rx::ApiLF::EPar::Depth_Path_LT_PatchStride
[out]	aValue	The array containing the parameter Value.

RXLF_API void Rx::ApiLF::RxGetPar	(	EPar::ID	ePar,
		Rx::CRxArrayDouble &	aValue
	)

Get Parameter of type CRxArrayDouble.

Warning

If the parameter referenced by ePar does not relate to an Rx::CRxArrayDouble parameter, then an Rx::ApiLF::CRxApiException is thrown.

Parameters

	ePar	The parameter ID. Allowed enum values are: Ray PreProcess Algorithm Rx::ApiLF::EPar::PreProc_Std_Gradation Depth Path Algorithm Rx::ApiLF::EPar::Depth_Path_LT_PixelStep Rx::ApiLF::EPar::Depth_Path_LT_MinStdDev Rx::ApiLF::EPar::Depth_Path_LT_MinCor Rx::ApiLF::EPar::Depth_Path_LT_MinPolyParAbs Rx::ApiLF::EPar::Depth_Path_LT_MaxPolyCtrDelta Sensor Rx::ApiLF::EPar::Sensor_RotationMatrix_g_s Rx::ApiLF::EPar::Sensor_TranslationMM_g_s Rx::ApiLF::EPar::Sensor_TotalSizeMM Rx::ApiLF::EPar::Sensor_SizeMM Rx::ApiLF::EPar::Sensor_OffsetMM Virtual Camera Rx::ApiLF::EPar::VirtCamPinholeStd_ViewOffsetMM_g Rx::ApiLF::EPar::VirtCamPinholeStd_FrustumMM_g Main Lens Thin Rx::ApiLF::EPar::MainLensThin_OpticalAxisDir_s Rx::ApiLF::EPar::MainLensThin_ImagePrincipalPointMM_s Main Lens Thick Rx::ApiLF::EPar::MainLensThick_OpticalAxisDir_s Rx::ApiLF::EPar::MainLensThick_ImagePrincipalPointMM_s MLA Rx::ApiLF::EPar::Mla_FocusRangeMinVD Rx::ApiLF::EPar::Mla_FocusRangeMaxVD Rx::ApiLF::EPar::Mla_OffsetMM_s Rx::ApiLF::EPar::Mla_OffsetPX_s Rx::ApiLF::EPar::Mla_CenterLensLocationMM Rx::ApiLF::EPar::Mla_CenterLensLocationPX Rx::ApiLF::EPar::Mla_MlaSensorDistanceMM Rx::ApiLF::EPar::Mla_NominalMlaSensorDistanceMM MLA Image Distortion Rx::ApiLF::EPar::MlaImg_RadialDistCenterPX_pxa Rx::ApiLF::EPar::MlaImg_UnDistHomographyWhiteImage
[out]	aValue	The array containing the parameter Value.

RXLF_API void Rx::ApiLF::RxGetPar	(	EPar::ID	ePar,
		Rx::CRxArrayString &	aValue
	)

Get Parameter of type CRxArrayString.

Warning

If the parameter referenced by ePar does not relate to an Rx::CRxArrayString parameter, then an Rx::ApiLF::CRxApiException is thrown.

Parameters

[in]	ePar	The parameter ID.
[out]	aValue	The array containing the parameter Value.

RXLF_API void Rx::ApiLF::RxGetPar	(	EPar::ID	ePar,
		const unsigned	uIndex,
		unsigned &	uValue
	)

Get Parameter of type unsigned int.This function is related to the overloaded function RxGetPar(EPar::ID ePar, Rx::CRxArrayUInt aValue) and will return the Value of the parameter array on given index.

Warning

If the parameter referenced by ePar does not relate to an Rx::CRxArrayUInt parameter, then an Rx::ApiLF::CRxApiException is thrown.

Halcon Plugin - Function Name:

rx_get_par_array_int

Parameters

	ePar	The parameter ID. Allowed enum values are: Depth Path Algorithm Rx::ApiLF::EPar::Depth_Path_LT_PatchDia Rx::ApiLF::EPar::Depth_Path_LT_PatchStride
[in]	uIndex	The array index.
[out]	uValue	The variable containing the parameter Value.

RXLF_API void Rx::ApiLF::RxGetPar	(	EPar::ID	ePar,
		const unsigned	uIndex,
		double &	dValue
	)

Get Parameter of type unsigned int. This function is related to the overloaded function RxGetPar(EPar::ID ePar, Rx::CRxArrayDouble aValue) and will return the Value of the parameter array on given index.

Warning

If the parameter referenced by ePar does not relate to an Rx::CRxArrayDouble parameter, then an Rx::ApiLF::CRxApiException is thrown.

Halcon Plugin - Function Name:

rx_get_par_array_float

Parameters

	ePar	The parameter ID. Allowed enum values are: Ray PreProcess Algorithm Rx::ApiLF::EPar::PreProc_Std_Gradation Depth Path Algorithm Rx::ApiLF::EPar::Depth_Path_LT_PixelStep Rx::ApiLF::EPar::Depth_Path_LT_MinStdDev Rx::ApiLF::EPar::Depth_Path_LT_MinCor Rx::ApiLF::EPar::Depth_Path_LT_MinPolyParAbs Rx::ApiLF::EPar::Depth_Path_LT_MaxPolyCtrDelta Sensor Rx::ApiLF::EPar::Sensor_RotationMatrix_g_s Rx::ApiLF::EPar::Sensor_TranslationMM_g_s Rx::ApiLF::EPar::Sensor_TotalSizeMM Rx::ApiLF::EPar::Sensor_SizeMM Rx::ApiLF::EPar::Sensor_OffsetMM Virtual Camera Rx::ApiLF::EPar::VirtCamPinholeStd_ViewOffsetMM_g Rx::ApiLF::EPar::VirtCamPinholeStd_FrustumMM_g Main Lens Thin Rx::ApiLF::EPar::MainLensThin_OpticalAxisDir_s Rx::ApiLF::EPar::MainLensThin_ImagePrincipalPointMM_s Main Lens Thick Rx::ApiLF::EPar::MainLensThick_OpticalAxisDir_s Rx::ApiLF::EPar::MainLensThick_ImagePrincipalPointMM_s MLA Rx::ApiLF::EPar::Mla_FocusRangeMinVD Rx::ApiLF::EPar::Mla_FocusRangeMaxVD Rx::ApiLF::EPar::Mla_OffsetMM_s Rx::ApiLF::EPar::Mla_OffsetPX_s Rx::ApiLF::EPar::Mla_CenterLensLocationMM Rx::ApiLF::EPar::Mla_CenterLensLocationPX Rx::ApiLF::EPar::Mla_MlaSensorDistanceMM Rx::ApiLF::EPar::Mla_NominalMlaSensorDistanceMM MLA Image Distortion Rx::ApiLF::EPar::MlaImg_RadialDistCenterPX_pxa Rx::ApiLF::EPar::MlaImg_UnDistHomographyWhiteImage
[in]	uIndex	The array index.
[out]	dValue	The variable containing the parameter Value.

RXLF_API void Rx::ApiLF::RxGetPar	(	EPar::ID	ePar,
		const unsigned	uIndex,
		Rx::CRxString &	sValue
	)

Get Parameter of type unsigned int. This function is related to the overloaded function RxGetPar(EPar::ID ePar, Rx::CRxArrayString aValue) and will return the Value of the parameter array on given index.

Warning

If the parameter referenced by ePar does not relate to an Rx::CRxArrayString parameter, then an Rx::ApiLF::CRxApiException is thrown.

Halcon Plugin - Function Name:

rx_get_par_array_string

Parameters

[in]	ePar	The parameter ID.
[in]	uIndex	The array index.
[out]	sValue	The variable containing the parameter Value.

RXLF_API void Rx::ApiLF::RxGetParName	(	EPar::ID	ePar,
		Rx::CRxString &	sValue
	)

Get the string representation of a parameter.

Parameters

	ePar	The parameter ID. Allowed enums are in Rx::ApiLF::EPar.
[out]	sValue	On return contains the parameter string representation.

RXLF_API void Rx::ApiLF::RxGetParProperties	(	EPar::ID	ePar,
		Rx::CRxString &	sValue,
		bool &	bReadAccess,
		bool &	bWriteAccess,
		EParameterDataType::ID &	eParameterType
	)

Get the Properties of a parameter.

Parameters

	ePar	The parameter ID. Allowed enums are in Rx::ApiLF::EPar.
[out]	sValue	On return contains the parameter string representation.
[out]	bReadAccess	On return contains the parameter ReadAccess flag.
[out]	bWriteAccess	On return contains the parameter WriteAccess flag.
[out]	eParameterType	On return contains the paramater DataType.

RXLF_API void Rx::ApiLF::RxGetParRange	(	EPar::ID	ePar,
		unsigned &	uMin,
		unsigned &	uMax
	)

Get the range of a parameter.

Attention

If the parameter referenced by ePar does not relate to an unsigned parameter, then an Rx::ApiLF::CRxApiException is thrown.

Halcon Plugin - Function Name:

rx_get_par_range_int.

Parameters

	ePar	The parameter ID. Allowed enum values are: Bound Ray Image Rx::ApiLF::EPar::Ray_ApplyFileSettings Ray Sequence Rx::ApiLF::EPar::RaySeq_AutoStoreCamFrames Rx::ApiLF::EPar::RaySeq_ApplyFileSettings Ray PreProcess Algorithm Rx::ApiLF::EPar::PreProc_Sharp1_Enable Rx::ApiLF::EPar::PreProc_Sharp1_OnlyCalc Rx::ApiLF::EPar::PreProc_Demosaic_Enable Rx::ApiLF::EPar::PreProc_DenoiseNLM_Enable Rx::ApiLF::EPar::PreProc_DenoiseNLM_FilterDia Depth Algorithm Rx::ApiLF::EPar::Depth3D_UseVirtualDepth Depth Path Algorithm Rx::ApiLF::EPar::Depth_Path_BlockCnt Rx::ApiLF::EPar::Depth_Path_NearResLevel Rx::ApiLF::EPar::Depth_Path_SparseLensSet Depth Fuse Direct Algorithm Rx::ApiLF::EPar::Depth_Fuse_MedianRad Rx::ApiLF::EPar::Depth_Fuse_MeanRad Depth Fill Algorithm Rx::ApiLF::EPar::Depth_Fill_Enabled Rx::ApiLF::EPar::Depth_Fill_IterCnt Rx::ApiLF::EPar::Depth_Fill_IterSize Rx::ApiLF::EPar::Depth_Fill_Complete Rx::ApiLF::EPar::Depth_Fill_Median_Enabled Rx::ApiLF::EPar::Depth_Fill_Median_Radius Rx::ApiLF::EPar::Depth_Fill_Mean_Enabled Rx::ApiLF::EPar::Depth_Fill_Mean_Radius Rx::ApiLF::EPar::Depth_Fill_NLM_Enabled Rx::ApiLF::EPar::Depth_Fill_NLM_FilterDia Rx::ApiLF::EPar::Depth_Fill_Bilateral_Enabled Rx::ApiLF::EPar::Depth_Fill_Bilateral_FilterRad Projection Rx::ApiLF::EPar::Proj_ViewingFrustumSpace2Type Rx::ApiLF::EPar::Proj_DepthPlanesAuto Rx::ApiLF::EPar::Proj_CurrentTargetView Virtual Camera Rx::ApiLF::EPar::VirtCamPinholeStd_LandscapeMode Rx::ApiLF::EPar::VirtCamPinholeStd_SensorScaling MLA Rx::ApiLF::EPar::Mla_LensTypeCount Rx::ApiLF::EPar::Mla_InvertAxisX Rx::ApiLF::EPar::Mla_InvertAxisY Rx::ApiLF::EPar::Mla_Rotation90Count MLA Image Distortion Rx::ApiLF::EPar::MlaImg_RadialDistType Rx::ApiLF::EPar::MlaImg_RadialDistParamCount Rx::ApiLF::EPar::MlaImg_HasParallelLightCalib Rx::ApiLF::EPar::MlaImg_CalibType Stereo Rx::ApiLF::EPar::Stereo_Type Defocus Blur Rx::ApiLF::EPar::Focus_DefocusBlur_Enable Rx::ApiLF::EPar::Focus_DefocusBlur_MaxBlurRad Grid Algorithm Rx::ApiLF::EPar::Grid_DrawOnWhiteImage Metric Calibration Parameters Rx::ApiLF::EPar::MC_Enable_StoreRefocusedImage Rx::ApiLF::EPar::MC_Enable_FocalLength Rx::ApiLF::EPar::MC_Enable_PrinciplePlaneSeperation Rx::ApiLF::EPar::MC_Enable_OpticalAxis Rx::ApiLF::EPar::MC_Enable_PrinciplePoint Rx::ApiLF::EPar::MC_Enable_MLAToSensorDistance Rx::ApiLF::EPar::MC_Enable_MLALensTypeRatio Rx::ApiLF::EPar::MC_Enable_Dist_Center Rx::ApiLF::EPar::MC_Enable_RadialPolyConst Rx::ApiLF::EPar::MC_Enable_RadialPoly Rx::ApiLF::EPar::MC_Enable_DepthPoly Rx::ApiLF::EPar::MC_Enable_AxialPoly Rx::ApiLF::EPar::MC_Callback_Registered Camera Capture Rx::ApiLF::EPar::CamCap_FrameBuffer_TotalCount Rx::ApiLF::EPar::CamCap_FrameBuffer_Overwrite Rx::ApiLF::EPar::CamCap_AutoGain_Enabled Rx::ApiLF::EPar::CamCap_AutoGain_Active Rx::ApiLF::EPar::CamCap_AutoGain_MinValue Rx::ApiLF::EPar::CamCap_AutoGain_MaxValue Rx::ApiLF::EPar::CamCap_AutoExposure_Enabled Rx::ApiLF::EPar::CamCap_AutoExposure_Active
[out]	uMin	The minimal value.
[out]	uMax	The maximal value.

RXLF_API void Rx::ApiLF::RxGetParRange	(	EPar::ID	ePar,
		double &	dMin,
		double &	dMax
	)

Get the range of a parameter.

Warning

If the parameter referenced by ePar does not relate to an double parameter, then an Rx::ApiLF::CRxApiException is thrown.

Halcon Plugin - Function Name:

rx_get_par_range_float.

Parameters

	ePar	The parameter ID. Allowed enum values are: Ray PreProcess Algorithm Rx::ApiLF::EPar::PreProc_Sharp1_BlurStdDev Rx::ApiLF::EPar::PreProc_Sharp1_Factor Rx::ApiLF::EPar::PreProc_Demosaic_R Rx::ApiLF::EPar::PreProc_Demosaic_G Rx::ApiLF::EPar::PreProc_Demosaic_B Rx::ApiLF::EPar::PreProc_DenoiseNLM_NoiseLevel Rx::ApiLF::EPar::PreProc_DenoiseNLM_BlendFactor Depth Algorithm Rx::ApiLF::EPar::Depth_ResImgDiv Depth Path Algorithm Rx::ApiLF::EPar::Depth_Path_MaxVirtDepth Depth Fuse Direct Algorithm Rx::ApiLF::EPar::Depth_Fuse_MeanMaxBlackPart Depth Fill Algorithm Rx::ApiLF::EPar::Depth_Fill_NLM_NoiseLevel Rx::ApiLF::EPar::Depth_Fill_NLM_BlendFactor Rx::ApiLF::EPar::Depth_Fill_Bilateral_Edge Rx::ApiLF::EPar::Depth_Fill_Bilateral_Range Focus Algorithm Rx::ApiLF::EPar::Focus_MaxLensContribRad Rx::ApiLF::EPar::Focus_RelativeFocusPlane Projection Rx::ApiLF::EPar::Proj_NominalFocusDistanceMM Rx::ApiLF::EPar::Proj_NominalFocalLengthMM Sensor# Rx::ApiLF::EPar::Sensor_PhysicalPixelSizeMM Virtual Camera Rx::ApiLF::EPar::VirtCamPinholeStd_ViewZoomFactor Rx::ApiLF::EPar::VirtCamPinholeStd_SensorSizeFactor Rx::ApiLF::EPar::VirtCamPinholeStd_ViewRotationDEG Main Lens Thin Rx::ApiLF::EPar::MainLensThin_FocalLengthMM Rx::ApiLF::EPar::MainLensThin_TotalFocusDistanceMM Main Lens Thick Rx::ApiLF::EPar::MainLensThick_FocalLengthMM Rx::ApiLF::EPar::MainLensThick_TotalFocusDistanceMM Rx::ApiLF::EPar::MainLensThick_PlaneSeparationMM MLA Rx::ApiLF::EPar::Mla_MlaBorderLU Stereo Rx::ApiLF::EPar::Stereo_EyeSeparation Defocus Blur Rx::ApiLF::EPar::Focus_DefocusBlur_VirtDOF Rx::ApiLF::EPar::Focus_DefocusBlur_Gradient Rx::ApiLF::EPar::Focus_DefocusBlur_DefaultDepth Camera Capture Rx::ApiLF::EPar::CamCap_AutoLum_MaxSaturatedPixelPercentage Rx::ApiLF::EPar::CamCap_AutoExposure_MinValue Rx::ApiLF::EPar::CamCap_AutoExposure_MaxValue
[out]	dMin	The minimal value.
[out]	dMax	The maximal value.

RXLF_API void Rx::ApiLF::RxGetParRange	(	EPar::ID	ePar,
		size_t &	iArrayLenMin,
		size_t &	iArrayLenMax,
		unsigned &	uMin,
		unsigned &	uMax
	)

Get the range of a parameter. Some array-based parameter have a dynamic array size. The parameter iArrayLenMin and iArrayLenMax returns the allowed length of the array on a zero based index.

Halcon Plugin - Function Name:

rx_get_par_range_array_int.

Parameters

	ePar	The parameter ID. Allowed enum values are: Depth Path Algorithm Rx::ApiLF::EPar::Depth_Path_LT_PatchDia Rx::ApiLF::EPar::Depth_Path_LT_PatchStride
[out]	iArrayLenMin	Zero-based index of the array length minimum.
[out]	iArrayLenMax	Zero-based index of the array length maximum.
[out]	uMin	The minimum.
[out]	uMax	The maximum.

RXLF_API void Rx::ApiLF::RxGetParRange	(	EPar::ID	ePar,
		size_t &	iArrayLenMin,
		size_t &	iArrayLenMax,
		double &	uMin,
		double &	uMax
	)

Get the range of a parameter. Some array-based parameter have a dynamic array size. The parameter iArrayLenMin and iArrayLenMax returns the allowed length of the array on a zero based index.

Halcon Plugin - Function Name:

rx_get_par_range_array_float.

Parameters

	ePar	The parameter ID. Allowed enum values are: Depth Path Algorithm Rx::ApiLF::EPar::Depth_Path_LT_MinStdDev Rx::ApiLF::EPar::Depth_Path_LT_MinCor Rx::ApiLF::EPar::Depth_Path_LT_MinPolyParAbs Rx::ApiLF::EPar::Depth_Path_LT_MaxPolyCtrDelta Sensor Rx::ApiLF::EPar::Sensor_RotationMatrix_g_s Rx::ApiLF::EPar::Sensor_TranslationMM_g_s Rx::ApiLF::EPar::Sensor_TotalSizeMM Rx::ApiLF::EPar::Sensor_SizeMM Rx::ApiLF::EPar::Sensor_OffsetMM Virtual Camera Rx::ApiLF::EPar::VirtCamPinholeStd_ViewOffsetMM_g Rx::ApiLF::EPar::VirtCamPinholeStd_FrustumMM_g Main Lens Thin Rx::ApiLF::EPar::MainLensThin_OpticalAxisDir_s Rx::ApiLF::EPar::MainLensThin_ImagePrincipalPointMM_s Main Lens Thick Rx::ApiLF::EPar::MainLensThick_OpticalAxisDir_s Rx::ApiLF::EPar::MainLensThick_ImagePrincipalPointMM_s MLA Rx::ApiLF::EPar::Mla_FocusRangeMinVD Rx::ApiLF::EPar::Mla_FocusRangeMaxVD Rx::ApiLF::EPar::Mla_OffsetMM_s Rx::ApiLF::EPar::Mla_OffsetPX_s Rx::ApiLF::EPar::Mla_CenterLensLocationMM Rx::ApiLF::EPar::Mla_CenterLensLocationPX Rx::ApiLF::EPar::Mla_MlaSensorDistanceMM Rx::ApiLF::EPar::Mla_NominalMlaSensorDistanceMM MLA Image Distortion Rx::ApiLF::EPar::MlaImg_RadialDistCenterPX_pxa Rx::ApiLF::EPar::MlaImg_UnDistHomographyWhiteImage
[out]	iArrayLenMin	Zero-based index of the array length minimum.
[out]	iArrayLenMax	Zero-based index of the array length maximum.
[out]	uMin	The minimum.
[out]	uMax	The maximum.

RXLF_API void Rx::ApiLF::RxLoadParameter

(

const Rx::CRxString &

sxFilename

)

Loads all writable API parameter from file. Its mandatory to bind a light field image before.

Halcon Plugin - Function Name:

rx_load_parameter.

Parameters

sxFilename

The filename.

RXLF_API void Rx::ApiLF::RxSaveParameter

(

const Rx::CRxString &

sxFilename

)

Saves all writable API parameter to file. Its mandatory to bind a light field image before.

This save routine will not store API parameter related to a specific device(e.g.camera or cuda device).

The following parameter groups are excluded from saving:

• Camera - all parameter starting with Rx::ApiLF::EPar::Cam_XXXX
• MLA - all parameter starting with Rx::ApiLF::EPar::MLA_XXXX

in addition to the excluded groups, the following parameter are also excluded:

• Rx::ApiLF::EPar::Proj_Type
• Rx::ApiLF::EPar::Proj_ViewingFrustumSpace2Type
• Rx::ApiLF::EPar::Proj_CurrentTargetView
• Rx::ApiLF::EPar::Proj_NominalFocusDistanceMM
• Rx::ApiLF::EPar::Proj_NominalFocalLengthMM
• Rx::ApiLF::EPar::Sensor_RotationMatrix_g_s
• Rx::ApiLF::EPar::Sensor_TranslationMM_g_s
• Rx::ApiLF::EPar::Sensor_TotalSizeMM
• Rx::ApiLF::EPar::Sensor_SizeMM
• Rx::ApiLF::EPar::Sensor_OffsetMM
• Rx::ApiLF::EPar::Sensor_PhysicalPixelSizeMM
• Rx::ApiLF::EPar::VirtCamPinholeStd_ViewOffsetMM_g
• Rx::ApiLF::EPar::VirtCamPinholeStd_ViewZoomFactor
• Rx::ApiLF::EPar::VirtCamPinholeStd_LandscapeMode
• Rx::ApiLF::EPar::VirtCamPinholeStd_SensorScaling
• Rx::ApiLF::EPar::VirtCamPinholeStd_FrustumMM_g
• Rx::ApiLF::EPar::VirtCamPinholeStd_SensorSizeFactor
• Rx::ApiLF::EPar::VirtCamPinholeStd_ViewRotationDEG
• Rx::ApiLF::EPar::MainLensThin_OpticalAxisDir_s
• Rx::ApiLF::EPar::MainLensThin_ImagePrincipalPointMM_s
• Rx::ApiLF::EPar::MainLensThin_FocalLengthMM
• Rx::ApiLF::EPar::MainLensThin_TotalFocusDistanceMM
• Rx::ApiLF::EPar::MainLensThick_OpticalAxisDir_s
• Rx::ApiLF::EPar::MainLensThick_ImagePrincipalPointMM_s
• Rx::ApiLF::EPar::MainLensThick_FocalLengthMM
• Rx::ApiLF::EPar::MainLensThick_TotalFocusDistanceMM
• Rx::ApiLF::EPar::MainLensThick_PlaneSeparationMM

Halcon Plugin - Function Name:

rx_save_parameter.

Parameters

sxFilename

The filename.

RXLF_API void Rx::ApiLF::RxSetPar	(	EPar::ID	ePar,
		const unsigned &	uValue
	)

Set a parameter of type unsigned integer.

Warning

If the parameter referenced by ePar does not relate to an unsigned integer parameter, then an Rx::ApiLF::CRxApiException is thrown.

Halcon Plugin - Function Name:

rx_set_par_int

Parameters

ePar

The parameter ID. Allowed enum values are: Bound Ray Image Rx::ApiLF::EPar::Ray_ApplyWhiteImage Rx::ApiLF::EPar::Ray_ConvBayer Rx::ApiLF::EPar::Ray_ApplyFileSettings OpenGL Rx::ApiLF::EPar::Gl_TexRayID Rx::ApiLF::EPar::Gl_TexFocusLeftID Rx::ApiLF::EPar::Gl_TexFocusRightID Rx::ApiLF::EPar::Gl_TexDepthLeftID Rx::ApiLF::EPar::Gl_TexDepthRightID Rx::ApiLF::EPar::Gl_TexDepthColLeftID Rx::ApiLF::EPar::Gl_TexDepthColRightID Rx::ApiLF::EPar::Gl_TexGridID Rx::ApiLF::EPar::Gl_TexFocusLeftID2 Rx::ApiLF::EPar::Gl_TexFocusRightID2 Rx::ApiLF::EPar::Gl_TexDepthMap Rx::ApiLF::EPar::Gl_TexRayProcID Rx::ApiLF::EPar::Gl_TexRayWhiteID Rx::ApiLF::EPar::Gl_TexRayDepthID Rx::ApiLF::EPar::Gl_TexStereoID Rx::ApiLF::EPar::Gl_TexDepthObjSpcID Rx::ApiLF::EPar::Gl_TexFocusObjSpcID Rx::ApiLF::EPar::Gl_TexDepthUndistortedID Rx::ApiLF::EPar::Gl_TexFocusUndistortedID Rx::ApiLF::EPar::Gl_TexDepthVirtualSpaceID Rx::ApiLF::EPar::Gl_TexFocusVirtualSpaceID Rx::ApiLF::EPar::Gl_TexDepthColLeftID2 Ray Sequence Rx::ApiLF::EPar::RaySeq_AutoStoreCamFrames Rx::ApiLF::EPar::RaySeq_ApplyFileSettings Rx::ApiLF::EPar::RaySeq_AutoStoreCamFrameCnt Ray PreProcess Algorithm Rx::ApiLF::EPar::PreProc_Std_Enable Rx::ApiLF::EPar::PreProc_Sharp1_Enable Rx::ApiLF::EPar::PreProc_Sharp1_OnlyCalc Rx::ApiLF::EPar::PreProc_Demosaic_Enable Rx::ApiLF::EPar::PreProc_DenoiseNLM_Enable Rx::ApiLF::EPar::PreProc_DenoiseNLM_FilterDia Depth Algorithm Rx::ApiLF::EPar::Depth3D_UseVirtualDepth Depth Path Algorithm Rx::ApiLF::EPar::Depth_Path_BlockCnt Rx::ApiLF::EPar::Depth_Path_NearResLevel Rx::ApiLF::EPar::Depth_Path_SparseLensSet Depth Fuse Direct Algorithm Rx::ApiLF::EPar::Depth_Fuse_MedianRad Rx::ApiLF::EPar::Depth_Fuse_MeanRad Depth Fill Algorithm Rx::ApiLF::EPar::Depth_Fill_Enabled Rx::ApiLF::EPar::Depth_Fill_IterCnt Rx::ApiLF::EPar::Depth_Fill_IterSize Rx::ApiLF::EPar::Depth_Fill_Complete Rx::ApiLF::EPar::Depth_Fill_Median_Enabled Rx::ApiLF::EPar::Depth_Fill_Median_Radius Rx::ApiLF::EPar::Depth_Fill_Mean_Enabled Rx::ApiLF::EPar::Depth_Fill_Mean_Radius Rx::ApiLF::EPar::Depth_Fill_NLM_Enabled Rx::ApiLF::EPar::Depth_Fill_NLM_FilterDia Rx::ApiLF::EPar::Depth_Fill_Bilateral_Enabled Rx::ApiLF::EPar::Depth_Fill_Bilateral_FilterRad Projection Rx::ApiLF::EPar::Proj_Type Rx::ApiLF::EPar::Proj_ViewingFrustumSpace2Type Rx::ApiLF::EPar::Proj_DepthPlanesAuto Rx::ApiLF::EPar::Proj_CurrentTargetView Virtual Camera Rx::ApiLF::EPar::VirtCamPinholeStd_LandscapeMode Rx::ApiLF::EPar::VirtCamPinholeStd_SensorScaling MLA Rx::ApiLF::EPar::Mla_LensTypeCount Rx::ApiLF::EPar::Mla_InvertAxisX Rx::ApiLF::EPar::Mla_InvertAxisY Rx::ApiLF::EPar::Mla_Rotation90Count MLA Image Distortion Rx::ApiLF::EPar::MlaImg_RadialDistType Rx::ApiLF::EPar::MlaImg_RadialDistParamCount Stereo Rx::ApiLF::EPar::Stereo_Type Defocus Blur Rx::ApiLF::EPar::Focus_DefocusBlur_Enable Rx::ApiLF::EPar::Focus_DefocusBlur_MaxBlurRad Grid Algorithm Rx::ApiLF::EPar::Grid_DrawOnWhiteImage Metric Calibration Parameters Rx::ApiLF::EPar::MC_Enable_StoreRefocusedImage Rx::ApiLF::EPar::MC_Enable_FocalLength Rx::ApiLF::EPar::MC_Enable_PrinciplePlaneSeperation Rx::ApiLF::EPar::MC_Enable_OpticalAxis Rx::ApiLF::EPar::MC_Enable_PrinciplePoint Rx::ApiLF::EPar::MC_Enable_MLAToSensorDistance Rx::ApiLF::EPar::MC_Enable_MLALensTypeRatio Rx::ApiLF::EPar::MC_Enable_Dist_Center Rx::ApiLF::EPar::MC_Enable_RadialPolyConst Rx::ApiLF::EPar::MC_Enable_RadialPoly Rx::ApiLF::EPar::MC_Enable_DepthPoly Rx::ApiLF::EPar::MC_Enable_AxialPoly Rx::ApiLF::EPar::MC_CalibrationIterationCount Rx::ApiLF::EPar::MC_TestModelFilter_SmoothRadius Rx::ApiLF::EPar::MC_TestModelFilter_Hist3dHorizBinCount Rx::ApiLF::EPar::MC_TestModelFilter_Hist3dDepthBinCount Rx::ApiLF::EPar::MC_TestModelFilter_MinPointCount Rx::ApiLF::EPar::MC_InitialTotalFocusDistanceMM Camera Capture Rx::ApiLF::EPar::CamCap_Timeout_Video Rx::ApiLF::EPar::CamCap_Timeout_Single Rx::ApiLF::EPar::CamCap_Timeout_Extern Rx::ApiLF::EPar::CamCap_FrameBuffer_TotalCount Rx::ApiLF::EPar::CamCap_FrameBuffer_Overwrite Rx::ApiLF::EPar::CamCap_FrameBuffer_FreeCount Rx::ApiLF::EPar::CamCap_FrameBuffer_UsedCount Rx::ApiLF::EPar::CamCap_Frames_Lost Rx::ApiLF::EPar::CamCap_AutoGain_Enabled Rx::ApiLF::EPar::CamCap_AutoGain_Active Rx::ApiLF::EPar::CamCap_AutoGain_MinValue Rx::ApiLF::EPar::CamCap_AutoGain_MaxValue Rx::ApiLF::EPar::CamCap_AutoExposure_Enabled Rx::ApiLF::EPar::CamCap_AutoExposure_Active

uValue

The parameter value.

RXLF_API void Rx::ApiLF::RxSetPar	(	EPar::ID	ePar,
		const double &	dValue
	)

Set a parameter of type double.

Warning

If the parameter referenced by ePar does not relate to an double parameter, then an Rx::ApiLF::CRxApiException is thrown.

Halcon Plugin - Function Name:

rx_set_par_float

Parameters

ePar

The parameter ID. Allowed enum values are: Ray PreProcess Algorithm Rx::ApiLF::EPar::PreProc_Std_Brightness Rx::ApiLF::EPar::PreProc_Std_ContrastCenter Rx::ApiLF::EPar::PreProc_Std_ContrastScale Rx::ApiLF::EPar::PreProc_Sharp1_BlurStdDev Rx::ApiLF::EPar::PreProc_Sharp1_Factor Rx::ApiLF::EPar::PreProc_Demosaic_R Rx::ApiLF::EPar::PreProc_Demosaic_G Rx::ApiLF::EPar::PreProc_Demosaic_B Rx::ApiLF::EPar::PreProc_DenoiseNLM_NoiseLevel Rx::ApiLF::EPar::PreProc_DenoiseNLM_BlendFactor Depth Algorithm Rx::ApiLF::EPar::Depth_ResImgDiv Rx::ApiLF::EPar::Depth_DefaultValue Depth Path Algorithm Rx::ApiLF::EPar::Depth_Path_MaxVirtDepth Depth Fuse Direct Algorithm Rx::ApiLF::EPar::Depth_Fuse_MeanMaxBlackPart Depth Fill Algorithm Rx::ApiLF::EPar::Depth_Fill_NLM_NoiseLevel Rx::ApiLF::EPar::Depth_Fill_NLM_BlendFactor Rx::ApiLF::EPar::Depth_Fill_Bilateral_Edge Rx::ApiLF::EPar::Depth_Fill_Bilateral_Range Focus Algorithm Rx::ApiLF::EPar::Focus_ResImgDiv Rx::ApiLF::EPar::Focus_MaxLensContribRad Rx::ApiLF::EPar::Focus_RelativeFocusPlane Projection Rx::ApiLF::EPar::Proj_NominalFocusDistanceMM Rx::ApiLF::EPar::Proj_NominalFocalLengthMM Sensor# Rx::ApiLF::EPar::Sensor_PhysicalPixelSizeMM Virtual Camera Rx::ApiLF::EPar::VirtCamPinholeStd_ViewZoomFactor Rx::ApiLF::EPar::VirtCamPinholeStd_SensorSizeFactor Main Lens Thin Rx::ApiLF::EPar::MainLensThin_FocalLengthMM Rx::ApiLF::EPar::MainLensThin_TotalFocusDistanceMM Main Lens Thick Rx::ApiLF::EPar::MainLensThick_FocalLengthMM Rx::ApiLF::EPar::MainLensThick_TotalFocusDistanceMM Rx::ApiLF::EPar::MainLensThick_PlaneSeparationMM MLA Rx::ApiLF::EPar::Mla_LensPitchMM Rx::ApiLF::EPar::Mla_LensPitchPX Rx::ApiLF::EPar::Mla_LensGapMM Rx::ApiLF::EPar::Mla_LensGapPX Rx::ApiLF::EPar::Mla_LensBorderMM Rx::ApiLF::EPar::Mla_LensBorderPX Rx::ApiLF::EPar::Mla_RotationRad Rx::ApiLF::EPar::Mla_MlaBorderLU Rx::ApiLF::EPar::Mla_NominalLensPitchMM Rx::ApiLF::EPar::Mla_NominalLensPitchPX Stereo Rx::ApiLF::EPar::Stereo_EyeSeparation Defocus Blur Rx::ApiLF::EPar::Focus_DefocusBlur_VirtDOF Rx::ApiLF::EPar::Focus_DefocusBlur_Gradient Rx::ApiLF::EPar::Focus_DefocusBlur_DefaultDepth Metric Calibration Parameters Rx::ApiLF::EPar::MC_TestModelFilter_OutlierThresholdVD Rx::ApiLF::EPar::MC_TestModelFilter_DepthStdDevThresholdVD Rx::ApiLF::EPar::MC_TestModelFilter_Hist3dVirtDepthMin Rx::ApiLF::EPar::MC_TestModelFilter_Hist3dVirtDepthMax Rx::ApiLF::EPar::MC_TestModelFilter_dHist3dCommonPartThreshold Rx::ApiLF::EPar::MC_ModelPointStep Rx::ApiLF::EPar::MC_InitialFocalLengthMM Camera Capture Rx::ApiLF::EPar::CamCap_AutoLum_MaxSaturatedPixelPercentage Rx::ApiLF::EPar::CamCap_AutoExposure_MinValue Rx::ApiLF::EPar::CamCap_AutoExposure_MaxValue

dValue

The parameter value.

RXLF_API void Rx::ApiLF::RxSetPar	(	EPar::ID	ePar,
		const Rx::CRxString &	sValue
	)

Set a parameter of type Rx::CRxString.

Attention

If the parameter referenced by ePar does not relate to an double parameter, then an Rx::ApiLF::CRxApiException is thrown.

Halcon Plugin - Function Name:

rx_set_par_string

Parameters

ePar	The parameter ID. Allowed enum values are: Depth Algorithm Rx::ApiLF::EPar::Depth_Algo
sValue	The parameter value.

RXLF_API void Rx::ApiLF::RxSetPar	(	EPar::ID	ePar,
		const Rx::CRxArrayUInt &	aValue
	)

Set a parameter of typeRx::CRxArrayUInt.

Attention

If the parameter referenced by ePar does not relate to an Rx::CRxArrayUInt parameter, then a Rx::ApiLF::CRxApiException is thrown.

Parameters

ePar	The parameter ID. Allowed enum values are: Depth Path Algorithm Rx::ApiLF::EPar::Depth_Path_LT_PatchDia Rx::ApiLF::EPar::Depth_Path_LT_PatchStride
aValue	The value.

RXLF_API void Rx::ApiLF::RxSetPar	(	EPar::ID	ePar,
		const Rx::CRxArrayDouble &	aValue
	)

Set a parameter of type Rx::CRxArrayDouble.

Attention

If the parameter referenced by ePar does not relate to an Rx::CRxArrayDouble parameter, then a Rx::ApiLF::CRxApiException is thrown.

Parameters

ePar

The parameter ID. Allowed enum values are: Ray PreProcess Algorithm Rx::ApiLF::EPar::PreProc_Std_Gradation Depth Path Algorithm Rx::ApiLF::EPar::Depth_Path_LT_PixelStep Rx::ApiLF::EPar::Depth_Path_LT_MinStdDev Rx::ApiLF::EPar::Depth_Path_LT_MinCor Rx::ApiLF::EPar::Depth_Path_LT_MinPolyParAbs Rx::ApiLF::EPar::Depth_Path_LT_MaxPolyCtrDelta Sensor Rx::ApiLF::EPar::Sensor_RotationMatrix_g_s Rx::ApiLF::EPar::Sensor_TranslationMM_g_s Rx::ApiLF::EPar::Sensor_TotalSizeMM Rx::ApiLF::EPar::Sensor_SizeMM Rx::ApiLF::EPar::Sensor_OffsetMM Virtual Camera Rx::ApiLF::EPar::VirtCamPinholeStd_ViewOffsetMM_g Main Lens Thin Rx::ApiLF::EPar::MainLensThin_OpticalAxisDir_s Rx::ApiLF::EPar::MainLensThin_ImagePrincipalPointMM_s Main Lens Thick Rx::ApiLF::EPar::MainLensThick_OpticalAxisDir_s Rx::ApiLF::EPar::MainLensThick_ImagePrincipalPointMM_s MLA Rx::ApiLF::EPar::Mla_FocusRangeMinVD Rx::ApiLF::EPar::Mla_FocusRangeMaxVD Rx::ApiLF::EPar::Mla_OffsetMM_s Rx::ApiLF::EPar::Mla_OffsetPX_s Rx::ApiLF::EPar::Mla_CenterLensLocationMM Rx::ApiLF::EPar::Mla_CenterLensLocationPX Rx::ApiLF::EPar::Mla_MlaSensorDistanceMM Rx::ApiLF::EPar::Mla_NominalMlaSensorDistanceMM MLA Image Distortion Rx::ApiLF::EPar::MlaImg_RadialDistCenterPX_pxa Rx::ApiLF::EPar::MlaImg_UnDistHomographyWhiteImage

aValue

The value.

RXLF_API void Rx::ApiLF::RxSetPar	(	EPar::ID	ePar,
		const Rx::CRxArrayString &	aValue
	)

Set a parameter of type Rx::CRxArrayString.

Attention

If the parameter referenced by ePar does not relate to an Rx::CRxArrayString parameter, then a Rx::ApiLF::CRxApiException is thrown.

Parameters

ePar	The parameter.
aValue	The parameter's value.

RXLF_API void Rx::ApiLF::RxSetPar	(	EPar::ID	ePar,
		const unsigned	uIndex,
		const unsigned &	uValue
	)

Set a Parameter of type unsiged. This function is related to void Rx::ApiLF::RxSetPar(Rx::ApiLF::EPar::ID ePar,const Rx::CRxArrayUInt aValue) and sets the Value of the array on the given index.

Attention

If the parameter referenced by ePar does not relate to an Rx::CRxArrayUInt parameter, then a Rx::ApiLF::CRxApiException is thrown.

Halcon Plugin - Function Name:

rx_set_par_array_int.

Parameters

ePar	The parameter ID. Allowed enum values are: Ray PreProcess Algorithm Rx::ApiLF::EPar::PreProc_Std_Gradation Depth Path Algorithm Rx::ApiLF::EPar::Depth_Path_LT_PixelStep Rx::ApiLF::EPar::Depth_Path_LT_MinStdDev Rx::ApiLF::EPar::Depth_Path_LT_MinCor Rx::ApiLF::EPar::Depth_Path_LT_MinPolyParAbs Rx::ApiLF::EPar::Depth_Path_LT_MaxPolyCtrDelta Sensor Rx::ApiLF::EPar::Sensor_RotationMatrix_g_s Rx::ApiLF::EPar::Sensor_TranslationMM_g_s Rx::ApiLF::EPar::Sensor_TotalSizeMM Rx::ApiLF::EPar::Sensor_SizeMM Rx::ApiLF::EPar::Sensor_OffsetMM Virtual Camera Rx::ApiLF::EPar::VirtCamPinholeStd_ViewOffsetMM_g Main Lens Thin Rx::ApiLF::EPar::MainLensThin_OpticalAxisDir_s Rx::ApiLF::EPar::MainLensThin_ImagePrincipalPointMM_s Main Lens Thick Rx::ApiLF::EPar::MainLensThick_OpticalAxisDir_s Rx::ApiLF::EPar::MainLensThick_ImagePrincipalPointMM_s MLA Rx::ApiLF::EPar::Mla_FocusRangeMinVD Rx::ApiLF::EPar::Mla_FocusRangeMaxVD Rx::ApiLF::EPar::Mla_OffsetMM_s Rx::ApiLF::EPar::Mla_OffsetPX_s Rx::ApiLF::EPar::Mla_CenterLensLocationMM Rx::ApiLF::EPar::Mla_CenterLensLocationPX Rx::ApiLF::EPar::Mla_MlaSensorDistanceMM Rx::ApiLF::EPar::Mla_NominalMlaSensorDistanceMM MLA Image Distortion Rx::ApiLF::EPar::MlaImg_RadialDistCenterPX_pxa Rx::ApiLF::EPar::MlaImg_UnDistHomographyWhiteImage
uIndex	The index of the array.
uValue	The value to set.

RXLF_API void Rx::ApiLF::RxSetPar	(	EPar::ID	ePar,
		const unsigned	uIndex,
		const double &	dValue
	)

Set a Parameter of type unsiged. This function is related to void Rx::ApiLF::RxSetPar(EPar::ID ePar, const Rx::CRxArrayDouble& aValue) and sets the Value of the array on the given index.

Warning

If the parameter referenced by ePar does not relate to an Rx::CRxArrayDouble parameter, then an Rx::ApiLF::CRxApiException is thrown.

Halcon Plugin - Function Name:

rx_set_par_array_float.

Parameters

ePar	The parameter ID. Allowed enum values are: Ray PreProcess Algorithm Rx::ApiLF::EPar::PreProc_Std_Gradation Depth Path Algorithm Rx::ApiLF::EPar::Depth_Path_LT_PixelStep Rx::ApiLF::EPar::Depth_Path_LT_MinStdDev Rx::ApiLF::EPar::Depth_Path_LT_MinCor Rx::ApiLF::EPar::Depth_Path_LT_MinPolyParAbs Rx::ApiLF::EPar::Depth_Path_LT_MaxPolyCtrDelta Sensor Rx::ApiLF::EPar::Sensor_RotationMatrix_g_s Rx::ApiLF::EPar::Sensor_TranslationMM_g_s Rx::ApiLF::EPar::Sensor_TotalSizeMM Rx::ApiLF::EPar::Sensor_SizeMM Rx::ApiLF::EPar::Sensor_OffsetMM Virtual Camera Rx::ApiLF::EPar::VirtCamPinholeStd_ViewOffsetMM_g Main Lens Thin Rx::ApiLF::EPar::MainLensThin_OpticalAxisDir_s Rx::ApiLF::EPar::MainLensThin_ImagePrincipalPointMM_s Main Lens Thick Rx::ApiLF::EPar::MainLensThick_OpticalAxisDir_s Rx::ApiLF::EPar::MainLensThick_ImagePrincipalPointMM_s MLA Rx::ApiLF::EPar::Mla_FocusRangeMinVD Rx::ApiLF::EPar::Mla_FocusRangeMaxVD Rx::ApiLF::EPar::Mla_OffsetMM_s Rx::ApiLF::EPar::Mla_OffsetPX_s Rx::ApiLF::EPar::Mla_CenterLensLocationMM Rx::ApiLF::EPar::Mla_CenterLensLocationPX Rx::ApiLF::EPar::Mla_MlaSensorDistanceMM Rx::ApiLF::EPar::Mla_NominalMlaSensorDistanceMM MLA Image Distortion Rx::ApiLF::EPar::MlaImg_RadialDistCenterPX_pxa Rx::ApiLF::EPar::MlaImg_UnDistHomographyWhiteImage
uIndex	The index of the array.
dValue	The value to set.

RXLF_API void Rx::ApiLF::RxSetPar	(	EPar::ID	ePar,
		const unsigned	uIndex,
		const Rx::CRxString &	sValue
	)

Set a Parameter of type unsiged. This function is related to void Rx::ApiLF::RxSetPar(EPar::ID ePar, const Rx::CRxArrayString& aValue) and sets the Value of the array on the given index.

Attention

If the parameter referenced by ePar does not relate to an Rx::CRxArrayString parameter, then an Rx::ApiLF::CRxApiException is thrown.

Halcon Plugin - Function Name:

rx_set_par_array_string.

Parameters

ePar	The parameter ID.
uIndex	The index of the array.
sValue	The value to set.