Raytrix Light Field SDK  v3.0
Logo
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events Groups Pages
Light Field Parameter API functions

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

Functions

static System::Void Rx::Net::ApiLF::RxGetPar (Rx::Net::ApiLF::EPar ePar, System::UInt32% uValue)
 Get a parameter of type unsigned integer. More...
 
static System::Void Rx::Net::ApiLF::RxGetPar (Rx::Net::ApiLF::EPar ePar, System::Double% dValue)
 Get a parameter of type double. More...
 
static System::Void Rx::Net::ApiLF::RxGetPar (Rx::Net::ApiLF::EPar ePar, System::String^ %sValue)
 Get a parameter of type System::String. More...
 
static System::Void Rx::Net::ApiLF::RxGetPar (Rx::Net::ApiLF::EPar ePar, array< System::UInt32 >^%aValue)
 Get Parameter of type array<System::UInt32>. More...
 
static System::Void Rx::Net::ApiLF::RxGetPar (Rx::Net::ApiLF::EPar ePar, array< System::Double >^%aValue)
 Get Parameter of type array<System::Double>. More...
 
static System::Void Rx::Net::ApiLF::RxGetPar (Rx::Net::ApiLF::EPar ePar, array< System::String^ >^%aValue)
 Get Parameter of type array<System::String^>. More...
 
static System::Void Rx::Net::ApiLF::RxGetPar (Rx::Net::ApiLF::EPar ePar, System::UInt32 uIndex, System::UInt32% uValue)
 Get Parameter of type unsigned int.This function is related to the overloaded function. More...
 
static System::Void Rx::Net::ApiLF::RxGetPar (Rx::Net::ApiLF::EPar ePar, System::UInt32 uIndex, System::Double% dValue)
 Get Parameter of type unsigned int. This function is related to the overloaded function. More...
 
static System::Void Rx::Net::ApiLF::RxGetPar (Rx::Net::ApiLF::EPar ePar, System::UInt32 uIndex, System::String^ %sValue)
 Get Parameter of type unsigned int. This function is related to the overloaded function. More...
 
static System::Void Rx::Net::ApiLF::RxGetParName (Rx::Net::ApiLF::EPar ePar, System::String^ %aValue)
 Get the string representation of a parameter. More...
 
static System::Void Rx::Net::ApiLF::RxGetParProperties (Rx::Net::ApiLF::EPar ePar, System::String^ %sName, System::Boolean% bReadAccess, System::Boolean% bWriteAccess, Rx::Net::ApiLF::EParameterDataType% eType)
 Get the Properties of a parameter. More...
 
static System::Void Rx::Net::ApiLF::RxGetParRange (Rx::Net::ApiLF::EPar ePar, System::UInt32% uMin, System::UInt32% uMax)
 Get the range of a parameter. More...
 
static System::Void Rx::Net::ApiLF::RxGetParRange (Rx::Net::ApiLF::EPar ePar, System::Double% dMin, System::Double% dMax)
 Get the range of a parameter. More...
 
static System::Void Rx::Net::ApiLF::RxGetParRange (Rx::Net::ApiLF::EPar ePar, System::Int32% iArrayLenMin, System::Int32% iArrayLenMax, System::UInt32% uMin, System::UInt32% 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...
 
static System::Void Rx::Net::ApiLF::RxGetParRange (Rx::Net::ApiLF::EPar ePar, System::Int32% iArrayLenMin, System::Int32% iArrayLenMax, System::Double% uMin, System::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...
 
static System::Void Rx::Net::ApiLF::RxLoadParameter (System::String^ sFilename)
 Loads all writable API parameter from file. Its mandatory to bind a light field image before. More...
 
static System::Void Rx::Net::ApiLF::RxSaveParameter (System::String^ sFilename)
 Saves all writable API parameter to file. Its mandatory to bind a light field image before. More...
 
static System::Void Rx::Net::ApiLF::RxSetPar (Rx::Net::ApiLF::EPar ePar, System::UInt32 uValue)
 Set a parameter of type unsigned integer. More...
 
static System::Void Rx::Net::ApiLF::RxSetPar (Rx::Net::ApiLF::EPar ePar, System::Double dValue)
 Set a parameter of type double. More...
 
static System::Void Rx::Net::ApiLF::RxSetPar (Rx::Net::ApiLF::EPar ePar, System::String^ sValue)
 Set a parameter of type System::String. More...
 
static System::Void Rx::Net::ApiLF::RxSetPar (Rx::Net::ApiLF::EPar ePar, array< System::UInt32 >^aValue)
 Set a parameter of typearray<System::UInt32>. More...
 
static System::Void Rx::Net::ApiLF::RxSetPar (Rx::Net::ApiLF::EPar ePar, array< System::Double >^aValue)
 Set a parameter of type array<System::Double>. More...
 
static System::Void Rx::Net::ApiLF::RxSetPar (Rx::Net::ApiLF::EPar ePar, array< System::String^ >^aValue)
 Set a parameter of type array<System::String^>. More...
 
static System::Void Rx::Net::ApiLF::RxSetPar (Rx::Net::ApiLF::EPar ePar, System::UInt32 uIndex, System::UInt32 uValue)
 Receive set par. Set a Parameter of type unsiged. This function is related to void Rx::Net::ApiLF::RxSetPar(Rx::Net::ApiLF::EPar::ID ePar,const Rx::CRxArrayUInt aValue) and sets the Value of the array on the given index. More...
 
static System::Void Rx::Net::ApiLF::RxSetPar (Rx::Net::ApiLF::EPar ePar, System::UInt32 uIndex, System::Double dValue)
 Set a Parameter of type unsiged. This function is related to void RxSetPar(EPar::ID ePar, const array< System::Double^> aValue) and sets the Value of the array on the given index. More...
 
static System::Void Rx::Net::ApiLF::RxSetPar (Rx::Net::ApiLF::EPar ePar, System::UInt32 uIndex, System::String^ sValue)
 Set a Parameter of type unsiged. This function is related to void RxSetPar(EPar::ID ePar, const array< System::String^> 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::Net::ApiLF::EPar. Note that the parameters starting with Rx::Net::ApiLF::EPar::Cam_ and Rx::Net::ApiLF::EPar::CamCal_ have to be read and set with Rx::Net::ApiLF::RxCamGetPar and Rx::Net::ApiLF::RxCamSetPar, with the exeception of Rx::Net::ApiLF::EPar::Cam_Count. The parameters are grouped in the following categories:

Attention
Getting and setting of camera parameter demands a bound camera.

Function Documentation

static System::Void Rx::Net::ApiLF::RxGetPar ( Rx::Net::ApiLF::EPar  ePar,
System::UInt32%  uValue 
)
static

Get a parameter of type unsigned integer.

Warning
If the parameter referenced by ePar does not relate to an unsigned parameter an Rx::Net::RxException is thrown.
Halcon Plugin - Function Name:
rx_get_par_int
Parameters
eParThe parameter ID. Allowed enum values are:
[out]uValueOn return contains the parameter value.
static System::Void Rx::Net::ApiLF::RxGetPar ( Rx::Net::ApiLF::EPar  ePar,
System::Double%  dValue 
)
static

Get a parameter of type double.

Warning
If the parameter referenced by ePar does not relate to an double parameter an Rx::Net::RxException is thrown.
Halcon Plugin - Function Name:
rx_get_par_float.
Parameters
eParThe parameter ID. Allowed enum values are:
[out]dValueOn return contains the parameter value.
static System::Void Rx::Net::ApiLF::RxGetPar ( Rx::Net::ApiLF::EPar  ePar,
System::String^ %  sValue 
)
static

Get a parameter of type System::String.

Warning
If the parameter referenced by ePar does not relate to an string parameter an Rx::Net::RxException is thrown.
Halcon Plugin - Function Name:
rx_get_par_string
Parameters
eParThe parameter ID. Allowed enum values are:
[out]sValueOn return contains the parameter value.
static System::Void Rx::Net::ApiLF::RxGetPar ( Rx::Net::ApiLF::EPar  ePar,
array< System::UInt32 >^%  aValue 
)
static

Get Parameter of type array<System::UInt32>.

Warning
If the parameter referenced by ePar does not relate to an array<System::UInt32> parameter, then an Rx::Net::RxException is thrown.
Parameters
eParThe parameter ID. Allowed enum values are:
[out]aValueThe array containing the parameter Value.
static System::Void Rx::Net::ApiLF::RxGetPar ( Rx::Net::ApiLF::EPar  ePar,
array< System::Double >^%  aValue 
)
static

Get Parameter of type array<System::Double>.

Warning
If the parameter referenced by ePar does not relate to an array<System::Double> parameter, then an Rx::Net::RxException is thrown.
Parameters
eParThe parameter ID. Allowed enum values are:
[out]aValueThe array containing the parameter Value.
static System::Void Rx::Net::ApiLF::RxGetPar ( Rx::Net::ApiLF::EPar  ePar,
array< System::String^ >^%  aValue 
)
static

Get Parameter of type array<System::String^>.

Warning
If the parameter referenced by ePar does not relate to an array<System::String^> parameter, then an Rx::Net::RxException is thrown.
Parameters
eParThe parameter ID.
[out]aValueThe array containing the parameter Value.
static System::Void Rx::Net::ApiLF::RxGetPar ( Rx::Net::ApiLF::EPar  ePar,
System::UInt32  uIndex,
System::UInt32%  uValue 
)
static

Get Parameter of type unsigned int.This function is related to the overloaded function.

array&lt;System::UInt32&gt; 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 array<System::UInt32> parameter, then an Rx::Net::RxException is thrown.
Halcon Plugin - Function Name:
rx_get_par_array_int
Parameters
eParThe parameter ID. Allowed enum values are:
uIndexThe array index.
[out]uValueThe variable containing the parameter Value.
static System::Void Rx::Net::ApiLF::RxGetPar ( Rx::Net::ApiLF::EPar  ePar,
System::UInt32  uIndex,
System::Double%  dValue 
)
static

Get Parameter of type unsigned int. This function is related to the overloaded function.

array<System::Double> 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 array<System::Double> parameter, then an Rx::Net::RxException is thrown.
Halcon Plugin - Function Name:
rx_get_par_array_float
Parameters
eParThe parameter ID. Allowed enum values are:
uIndexThe array index.
[out]dValueThe variable containing the parameter Value.
static System::Void Rx::Net::ApiLF::RxGetPar ( Rx::Net::ApiLF::EPar  ePar,
System::UInt32  uIndex,
System::String^ %  sValue 
)
static

Get Parameter of type unsigned int. This function is related to the overloaded function.

array<System::String> 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 array<System::String> parameter, then an Rx::Net::RxException is thrown.
Halcon Plugin - Function Name:
rx_get_par_array_string
Parameters
eParThe parameter ID.
uIndexThe array index.
[out]sValueThe variable containing the parameter Value.
static System::Void Rx::Net::ApiLF::RxGetParName ( Rx::Net::ApiLF::EPar  ePar,
System::String^ %  aValue 
)
static

Get the string representation of a parameter.

Parameters
eParThe parameter ID. Allowed enums are in Rx::Net::ApiLF::EPar.
[out]aValueOn return contains the parameter string representation.
static System::Void Rx::Net::ApiLF::RxGetParProperties ( Rx::Net::ApiLF::EPar  ePar,
System::String^ %  sName,
System::Boolean%  bReadAccess,
System::Boolean%  bWriteAccess,
Rx::Net::ApiLF::EParameterDataType eType 
)
static

Get the Properties of a parameter.

Parameters
eParThe parameter ID. Allowed enums are in Rx::Net::ApiLF::EPar.
[out]sNameOn return contains the parameter string representation.
[out]bReadAccessOn return contains the parameter ReadAccess flag.
[out]bWriteAccessOn return contains the parameter WriteAccess flag.
[out]eTypeOn return contains the parameter DataType.
static System::Void Rx::Net::ApiLF::RxGetParRange ( Rx::Net::ApiLF::EPar  ePar,
System::UInt32%  uMin,
System::UInt32%  uMax 
)
static

Get the range of a parameter.

Attention
If the parameter referenced by ePar does not relate to an unsigned parameter, then an Rx::Net::RxException is thrown.
Halcon Plugin - Function Name:
rx_get_par_range_int.
Parameters
eParThe parameter ID. Allowed enum values are:
[out]uMinThe minimal value.
[out]uMaxThe maximal value.
static System::Void Rx::Net::ApiLF::RxGetParRange ( Rx::Net::ApiLF::EPar  ePar,
System::Double%  dMin,
System::Double%  dMax 
)
static

Get the range of a parameter.

Warning
If the parameter referenced by ePar does not relate to an double parameter, then an Rx::Net::RxException is thrown.
Halcon Plugin - Function Name:
rx_get_par_range_float.
Parameters
eParThe parameter ID. Allowed enum values are:
[out]dMinThe minimal value.
[out]dMaxThe maximal value.
static System::Void Rx::Net::ApiLF::RxGetParRange ( Rx::Net::ApiLF::EPar  ePar,
System::Int32%  iArrayLenMin,
System::Int32%  iArrayLenMax,
System::UInt32%  uMin,
System::UInt32%  uMax 
)
static

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
eParThe parameter ID. Allowed enum values are:
[out]iArrayLenMinZero-based index of the array length minimum.
[out]iArrayLenMaxZero-based index of the array length maximum.
[out]uMinThe minimum.
[out]uMaxThe maximum.
static System::Void Rx::Net::ApiLF::RxGetParRange ( Rx::Net::ApiLF::EPar  ePar,
System::Int32%  iArrayLenMin,
System::Int32%  iArrayLenMax,
System::Double%  uMin,
System::Double%  uMax 
)
static

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
eParThe parameter ID. Allowed enum values are:
[out]iArrayLenMinZero-based index of the array length minimum.
[out]iArrayLenMaxZero-based index of the array length maximum.
[out]uMinThe minimum.
[out]uMaxThe maximum.
static System::Void Rx::Net::ApiLF::RxLoadParameter ( System::String^  sFilename)
static

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

Halcon Plugin - Function Name:
rx_load_parameter.
Parameters
[in]sFilenameThe file name.
static System::Void Rx::Net::ApiLF::RxSaveParameter ( System::String^  sFilename)
static

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::Net::ApiLF::EPar::Cam_XXXX
  • MLA - all parameter starting with Rx::Net::ApiLF::EPar::MLA_XXXX

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

Halcon Plugin - Function Name:
rx_save_parameter.
Parameters
[in]sFilenameThe file name.
static System::Void Rx::Net::ApiLF::RxSetPar ( Rx::Net::ApiLF::EPar  ePar,
System::UInt32  uValue 
)
static

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::Net::RxException is thrown.
Halcon Plugin - Function Name:
rx_set_par_int
Parameters
eParThe parameter ID. Allowed enum values are:
uValueThe parameter value.
static System::Void Rx::Net::ApiLF::RxSetPar ( Rx::Net::ApiLF::EPar  ePar,
System::Double  dValue 
)
static

Set a parameter of type double.

Warning
If the parameter referenced by ePar does not relate to an double parameter, then an Rx::Net::RxException is thrown.
Halcon Plugin - Function Name:
rx_set_par_float
Parameters
eParThe parameter ID. Allowed enum values are:
dValueThe parameter value.
static System::Void Rx::Net::ApiLF::RxSetPar ( Rx::Net::ApiLF::EPar  ePar,
System::String^  sValue 
)
static

Set a parameter of type System::String.

Attention
If the parameter referenced by ePar does not relate to an double parameter, then an Rx::Net::RxException is thrown.
Halcon Plugin - Function Name:
rx_set_par_string
Parameters
eParThe parameter ID. Allowed enum values are:
[in]sValueThe parameter value.
static System::Void Rx::Net::ApiLF::RxSetPar ( Rx::Net::ApiLF::EPar  ePar,
array< System::UInt32 >^  aValue 
)
static

Set a parameter of typearray<System::UInt32>.

Attention
If the parameter referenced by ePar does not relate to an array<System::UInt32> parameter, then a Rx::Net::RxException is thrown.
Parameters
eParThe parameter ID. Allowed enum values are:
[in]aValueThe value.
static System::Void Rx::Net::ApiLF::RxSetPar ( Rx::Net::ApiLF::EPar  ePar,
array< System::Double >^  aValue 
)
static

Set a parameter of type array<System::Double>.

Attention
If the parameter referenced by ePar does not relate to an array<System::Double> parameter, then a Rx::Net::RxException is thrown.
Parameters
eParThe parameter ID. Allowed enum values are:
[in]aValueThe value.
static System::Void Rx::Net::ApiLF::RxSetPar ( Rx::Net::ApiLF::EPar  ePar,
array< System::String^ >^  aValue 
)
static

Set a parameter of type array<System::String^>.

Attention
If the parameter referenced by ePar does not relate to an array<System::String^> parameter, then a Rx::Net::RxException is thrown.
Parameters
eParThe parameter.
[in]aValueThe parameter's value.
static System::Void Rx::Net::ApiLF::RxSetPar ( Rx::Net::ApiLF::EPar  ePar,
System::UInt32  uIndex,
System::UInt32  uValue 
)
static

Receive set par. Set a Parameter of type unsiged. This function is related to void Rx::Net::ApiLF::RxSetPar(Rx::Net::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::Net::ApiLF::CRxApiException is thrown.
Halcon Plugin - Function Name:
rx_set_par_array_int.
Parameters
eParThe parameter ID. Allowed enum values are:
uIndexThe index of the array.
uValueThe value to set.
static System::Void Rx::Net::ApiLF::RxSetPar ( Rx::Net::ApiLF::EPar  ePar,
System::UInt32  uIndex,
System::Double  dValue 
)
static

Set a Parameter of type unsiged. This function is related to void RxSetPar(EPar::ID ePar, const array< System::Double^> 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::Net::ApiLF::CRxApiException is thrown.
Halcon Plugin - Function Name:
rx_set_par_array_float.
Parameters
eParThe parameter ID. Allowed enum values are:
uIndexThe index of the array.
dValueThe value to set.
static System::Void Rx::Net::ApiLF::RxSetPar ( Rx::Net::ApiLF::EPar  ePar,
System::UInt32  uIndex,
System::String^  sValue 
)
static

Set a Parameter of type unsiged. This function is related to void RxSetPar(EPar::ID ePar, const array< System::String^> aValue) and sets the Value of the array on the given index.

Attention
If the parameter referenced by ePar does not relate to an array<System::String^> parameter, then an Rx::Net::RxException is thrown.
Halcon Plugin - Function Name:
rx_set_par_array_string.
Parameters
eParThe parameter ID.
uIndexThe index of the array.
[in]sValueThe value to set.