Raytrix Light Field SDK  v3.1
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 void Rx::Net::ApiLF::RxGetPar (Rx::Net::ApiLF::EPar ePar, [Out] unsigned% uValue)
 Gets the value of a parameter. More...
 
static void Rx::Net::ApiLF::RxGetPar (Rx::Net::ApiLF::EPar ePar, [Out] double% dValue)
 Gets the value of a parameter. More...
 
static void Rx::Net::ApiLF::RxGetPar (Rx::Net::ApiLF::EPar ePar, [Out] System::String^ %sValue)
 Gets the value of a parameter. More...
 
static void Rx::Net::ApiLF::RxGetPar (Rx::Net::ApiLF::EPar ePar, [Out] array< unsigned >^%auValue)
 Gets the value of a parameter. More...
 
static void Rx::Net::ApiLF::RxGetPar (Rx::Net::ApiLF::EPar ePar, [Out] array< double >^%adValue)
 Gets the value of a parameter. More...
 
static void Rx::Net::ApiLF::RxGetPar (Rx::Net::ApiLF::EPar ePar, [Out] array< System::String^ >^%asValue)
 Gets the value of a parameter. More...
 
static void Rx::Net::ApiLF::RxGetPar (Rx::Net::ApiLF::EPar ePar, unsigned uIndex, [Out] unsigned% uValue)
 Gets the value of an array parameter at the given index. More...
 
static void Rx::Net::ApiLF::RxGetPar (Rx::Net::ApiLF::EPar ePar, unsigned uIndex, [Out] double% dValue)
 Gets the value of an array parameter at the given index. More...
 
static void Rx::Net::ApiLF::RxGetPar (Rx::Net::ApiLF::EPar ePar, unsigned uIndex, [Out] System::String^ %sValue)
 Gets the value of an array parameter at the given index. More...
 
static void Rx::Net::ApiLF::RxGetParName (Rx::Net::ApiLF::EPar ePar, [Out] System::String^ %aValue)
 Get the string representation of a parameter. More...
 
static void Rx::Net::ApiLF::RxGetParProperties (Rx::Net::ApiLF::EPar ePar, [Out] System::String^ %sName, [Out] bool% bReadAccess, [Out] bool% bWriteAccess, Rx::Net::ApiLF::EParameterDataType% eType)
 Get the Properties of a parameter. More...
 
static void Rx::Net::ApiLF::RxGetParRange (Rx::Net::ApiLF::EPar ePar, [Out] unsigned% uMin, [Out] unsigned% uMax)
 Get the value range of a parameter. More...
 
static void Rx::Net::ApiLF::RxGetParRange (Rx::Net::ApiLF::EPar ePar, [Out] double% dMin, [Out] double% dMax)
 Get the value range of a parameter. More...
 
static void Rx::Net::ApiLF::RxGetParRange (Rx::Net::ApiLF::EPar ePar, [Out] int% iMinCount, [Out] int% iMaxCount, [Out] unsigned% uMin, [Out] unsigned% uMax)
 Get the value range of an array parameter and the min and max allowed number of elements in the array. More...
 
static void Rx::Net::ApiLF::RxGetParRange (Rx::Net::ApiLF::EPar ePar, [Out] int% iMinCount, [Out] int% iMaxCount, [Out] double% dMin, [Out] double% dMax)
 Get the value range of an array parameter and the min and max allowed number of elements in the array. More...
 
static void 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 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 void Rx::Net::ApiLF::RxSetPar (Rx::Net::ApiLF::EPar ePar, unsigned uValue)
 Sets the value of a parameter. More...
 
static void Rx::Net::ApiLF::RxSetPar (Rx::Net::ApiLF::EPar ePar, double dValue)
 Sets the value of a parameter. More...
 
static void Rx::Net::ApiLF::RxSetPar (Rx::Net::ApiLF::EPar ePar, System::String^ sValue)
 Sets the value of a parameter. More...
 
static void Rx::Net::ApiLF::RxSetPar (Rx::Net::ApiLF::EPar ePar, array< unsigned >^auValue)
 Sets the value of a parameter. More...
 
static void Rx::Net::ApiLF::RxSetPar (Rx::Net::ApiLF::EPar ePar, array< double >^adValue)
 Sets the value of a parameter. More...
 
static void Rx::Net::ApiLF::RxSetPar (Rx::Net::ApiLF::EPar ePar, array< System::String^ >^asValue)
 Sets the value of a parameter. More...
 
static void Rx::Net::ApiLF::RxSetPar (Rx::Net::ApiLF::EPar ePar, unsigned uIndex, unsigned uValue)
 Sets the value of an array parameter at the given index. More...
 
static void Rx::Net::ApiLF::RxSetPar (Rx::Net::ApiLF::EPar ePar, unsigned uIndex, double dValue)
 Sets the value of an array parameter at the given index. More...
 
static void Rx::Net::ApiLF::RxSetPar (Rx::Net::ApiLF::EPar ePar, unsigned uIndex, System::String^ sValue)
 Sets the value of an array parameter at 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 void Rx::Net::ApiLF::RxGetPar ( Rx::Net::ApiLF::EPar  ePar,
[Out] unsigned%  uValue 
)
static

Gets the value of a parameter.

Parameters
eParThe ID of the parameter. Allowed values are:
uValue[out] The value of the parameter.
static void Rx::Net::ApiLF::RxGetPar ( Rx::Net::ApiLF::EPar  ePar,
[Out] double%  dValue 
)
static

Gets the value of a parameter.

Parameters
eParThe ID of the parameter. Allowed values are:
dValue[out] The value of the parameter.
static void Rx::Net::ApiLF::RxGetPar ( Rx::Net::ApiLF::EPar  ePar,
[Out] System::String^ %  sValue 
)
static

Gets the value of a parameter.

Parameters
eParThe ID of the parameter. Allowed values are:
sValue[out] The value of the parameter.
static void Rx::Net::ApiLF::RxGetPar ( Rx::Net::ApiLF::EPar  ePar,
[Out] array< unsigned >^%  auValue 
)
static

Gets the value of a parameter.

Parameters
eParThe ID of the parameter. Allowed values are:
auValue[out] The value of the parameter.
static void Rx::Net::ApiLF::RxGetPar ( Rx::Net::ApiLF::EPar  ePar,
[Out] array< double >^%  adValue 
)
static

Gets the value of a parameter.

Parameters
eParThe ID of the parameter. Allowed values are:
adValue[out] The value of the parameter.
static void Rx::Net::ApiLF::RxGetPar ( Rx::Net::ApiLF::EPar  ePar,
[Out] array< System::String^ >^%  asValue 
)
static

Gets the value of a parameter.

Parameters
eParThe ID of the parameter. Allowed values are:
asValue[out] The value of the parameter.
static void Rx::Net::ApiLF::RxGetPar ( Rx::Net::ApiLF::EPar  ePar,
unsigned  uIndex,
[Out] unsigned%  uValue 
)
static

Gets the value of an array parameter at the given index.

Parameters
eParThe ID of the parameter. Allowed values are:
uIndexThe array index.
uValue[out] The value of the parameter.
static void Rx::Net::ApiLF::RxGetPar ( Rx::Net::ApiLF::EPar  ePar,
unsigned  uIndex,
[Out] double%  dValue 
)
static

Gets the value of an array parameter at the given index.

Parameters
eParThe ID of the parameter. Allowed values are:
uIndexThe array index.
dValue[out] The value of the parameter.
static void Rx::Net::ApiLF::RxGetPar ( Rx::Net::ApiLF::EPar  ePar,
unsigned  uIndex,
[Out] System::String^ %  sValue 
)
static

Gets the value of an array parameter at the given index.

Parameters
eParThe ID of the parameter. Allowed values are:
uIndexThe array index.
sValue[out] The value of the parameter.
static void Rx::Net::ApiLF::RxGetParName ( Rx::Net::ApiLF::EPar  ePar,
[Out] 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 void Rx::Net::ApiLF::RxGetParProperties ( Rx::Net::ApiLF::EPar  ePar,
[Out] System::String^ %  sName,
[Out] bool%  bReadAccess,
[Out] bool%  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 void Rx::Net::ApiLF::RxGetParRange ( Rx::Net::ApiLF::EPar  ePar,
[Out] unsigned%  uMin,
[Out] unsigned%  uMax 
)
static

Get the value range of a parameter.

Parameters
eParThe ID of the parameter. Allowed values are:
uMin[out] The min allowed value of the parameter.
uMax[out] The max allowed value of the parameter.
static void Rx::Net::ApiLF::RxGetParRange ( Rx::Net::ApiLF::EPar  ePar,
[Out] double%  dMin,
[Out] double%  dMax 
)
static

Get the value range of a parameter.

Parameters
eParThe ID of the parameter. Allowed values are:
dMin[out] The min allowed value of the parameter.
dMax[out] The max allowed value of the parameter.
static void Rx::Net::ApiLF::RxGetParRange ( Rx::Net::ApiLF::EPar  ePar,
[Out] int%  iMinCount,
[Out] int%  iMaxCount,
[Out] unsigned%  uMin,
[Out] unsigned%  uMax 
)
static

Get the value range of an array parameter and the min and max allowed number of elements in the array.

Parameters
eParThe ID of the parameter. Allowed values are:
iMinCount[out] The min number of values allowed in the array.
iMaxCount[out] The max number of values allowed in the array.
uMin[out] The min allowed value of the parameter.
uMax[out] The max allowed value of the parameter.
static void Rx::Net::ApiLF::RxGetParRange ( Rx::Net::ApiLF::EPar  ePar,
[Out] int%  iMinCount,
[Out] int%  iMaxCount,
[Out] double%  dMin,
[Out] double%  dMax 
)
static

Get the value range of an array parameter and the min and max allowed number of elements in the array.

Parameters
eParThe ID of the parameter. Allowed values are:
iMinCount[out] The min number of values allowed in the array.
iMaxCount[out] The max number of values allowed in the array.
dMin[out] The min allowed value of the parameter.
dMax[out] The max allowed value of the parameter.
static 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 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 void Rx::Net::ApiLF::RxSetPar ( Rx::Net::ApiLF::EPar  ePar,
unsigned  uValue 
)
static

Sets the value of a parameter.

Parameters
eParThe ID of the parameter. Allowed values are:
uValue[in] The value of the parameter.
static void Rx::Net::ApiLF::RxSetPar ( Rx::Net::ApiLF::EPar  ePar,
double  dValue 
)
static

Sets the value of a parameter.

Parameters
eParThe ID of the parameter. Allowed values are:
dValue[in] The value of the parameter.
static void Rx::Net::ApiLF::RxSetPar ( Rx::Net::ApiLF::EPar  ePar,
System::String^  sValue 
)
static

Sets the value of a parameter.

Parameters
eParThe ID of the parameter. Allowed values are:
sValue[in] The value of the parameter.
static void Rx::Net::ApiLF::RxSetPar ( Rx::Net::ApiLF::EPar  ePar,
array< unsigned >^  auValue 
)
static

Sets the value of a parameter.

Parameters
eParThe ID of the parameter. Allowed values are:
auValue[in] The value of the parameter.
static void Rx::Net::ApiLF::RxSetPar ( Rx::Net::ApiLF::EPar  ePar,
array< double >^  adValue 
)
static

Sets the value of a parameter.

Parameters
eParThe ID of the parameter. Allowed values are:
adValue[in] The value of the parameter.
static void Rx::Net::ApiLF::RxSetPar ( Rx::Net::ApiLF::EPar  ePar,
array< System::String^ >^  asValue 
)
static

Sets the value of a parameter.

Parameters
eParThe ID of the parameter. Allowed values are:
asValue[in] The value of the parameter.
static void Rx::Net::ApiLF::RxSetPar ( Rx::Net::ApiLF::EPar  ePar,
unsigned  uIndex,
unsigned  uValue 
)
static

Sets the value of an array parameter at the given index.

Parameters
eParThe ID of the parameter. Allowed values are:
uIndexThe array index.
uValue[in] The value of the parameter.
static void Rx::Net::ApiLF::RxSetPar ( Rx::Net::ApiLF::EPar  ePar,
unsigned  uIndex,
double  dValue 
)
static

Sets the value of an array parameter at the given index.

Parameters
eParThe ID of the parameter. Allowed values are:
uIndexThe array index.
dValue[in] The value of the parameter.
static void Rx::Net::ApiLF::RxSetPar ( Rx::Net::ApiLF::EPar  ePar,
unsigned  uIndex,
System::String^  sValue 
)
static

Sets the value of an array parameter at the given index.

Parameters
eParThe ID of the parameter. Allowed values are:
uIndexThe array index.
sValue[in] The value of the parameter.