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

RXLF_API void Rx::ApiLF::RxGetPar (Rx::ApiLF::EPar::ID ePar, unsigned &uValue)
 Gets the value of a parameter. More...
 
RXLF_API void Rx::ApiLF::RxGetPar (Rx::ApiLF::EPar::ID ePar, double &dValue)
 Gets the value of a parameter. More...
 
RXLF_API void Rx::ApiLF::RxGetPar (Rx::ApiLF::EPar::ID ePar, CRxString &sValue)
 Gets the value of a parameter. More...
 
RXLF_API void Rx::ApiLF::RxGetPar (Rx::ApiLF::EPar::ID ePar, CRxArrayUInt &auValue)
 Gets the value of a parameter. More...
 
RXLF_API void Rx::ApiLF::RxGetPar (Rx::ApiLF::EPar::ID ePar, CRxArrayDouble &adValue)
 Gets the value of a parameter. More...
 
RXLF_API void Rx::ApiLF::RxGetPar (Rx::ApiLF::EPar::ID ePar, CRxArrayString &asValue)
 Gets the value of a parameter. More...
 
RXLF_API void Rx::ApiLF::RxGetPar (Rx::ApiLF::EPar::ID ePar, unsigned uIndex, unsigned &uValue)
 Gets the value of an array parameter at the given index. More...
 
RXLF_API void Rx::ApiLF::RxGetPar (Rx::ApiLF::EPar::ID ePar, unsigned uIndex, double &dValue)
 Gets the value of an array parameter at the given index. More...
 
RXLF_API void Rx::ApiLF::RxGetPar (Rx::ApiLF::EPar::ID ePar, unsigned uIndex, CRxString &sValue)
 Gets the value of an array parameter at the 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 (Rx::ApiLF::EPar::ID ePar, unsigned &uMin, unsigned &uMax)
 Get the value range of a parameter. More...
 
RXLF_API void Rx::ApiLF::RxGetParRange (Rx::ApiLF::EPar::ID ePar, double &dMin, double &dMax)
 Get the value range of a parameter. More...
 
RXLF_API void Rx::ApiLF::RxGetParRange (Rx::ApiLF::EPar::ID ePar, size_t &iMinCount, size_t &iMaxCount, unsigned &uMin, unsigned &uMax)
 Get the value range of an array parameter and the min and max allowed number of elements in the array. More...
 
RXLF_API void Rx::ApiLF::RxGetParRange (Rx::ApiLF::EPar::ID ePar, size_t &iMinCount, size_t &iMaxCount, double &dMin, double &dMax)
 Get the value range of an array parameter and the min and max allowed number of elements in the array. 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 (Rx::ApiLF::EPar::ID ePar, unsigned uValue)
 Sets the value of a parameter. More...
 
RXLF_API void Rx::ApiLF::RxSetPar (Rx::ApiLF::EPar::ID ePar, double dValue)
 Sets the value of a parameter. More...
 
RXLF_API void Rx::ApiLF::RxSetPar (Rx::ApiLF::EPar::ID ePar, const CRxString &sValue)
 Sets the value of a parameter. More...
 
RXLF_API void Rx::ApiLF::RxSetPar (Rx::ApiLF::EPar::ID ePar, const CRxArrayUInt &auValue)
 Sets the value of a parameter. More...
 
RXLF_API void Rx::ApiLF::RxSetPar (Rx::ApiLF::EPar::ID ePar, const CRxArrayDouble &adValue)
 Sets the value of a parameter. More...
 
RXLF_API void Rx::ApiLF::RxSetPar (Rx::ApiLF::EPar::ID ePar, const CRxArrayString &asValue)
 Sets the value of a parameter. More...
 
RXLF_API void Rx::ApiLF::RxSetPar (Rx::ApiLF::EPar::ID ePar, unsigned uIndex, unsigned uValue)
 Sets the value of an array parameter at the given index. More...
 
RXLF_API void Rx::ApiLF::RxSetPar (Rx::ApiLF::EPar::ID ePar, unsigned uIndex, double dValue)
 Sets the value of an array parameter at the given index. More...
 
RXLF_API void Rx::ApiLF::RxSetPar (Rx::ApiLF::EPar::ID ePar, unsigned uIndex, const CRxString &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::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:

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

Function Documentation

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

Gets the value of a parameter.

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

Gets the value of a parameter.

Parameters
eParThe ID of the parameter. Allowed values are:
dValue[out] The value of the parameter.
RXLF_API void Rx::ApiLF::RxGetPar ( Rx::ApiLF::EPar::ID  ePar,
CRxString &  sValue 
)

Gets the value of a parameter.

Parameters
eParThe ID of the parameter. Allowed values are:
sValue[out] The value of the parameter.
RXLF_API void Rx::ApiLF::RxGetPar ( Rx::ApiLF::EPar::ID  ePar,
CRxArrayUInt &  auValue 
)

Gets the value of a parameter.

Parameters
eParThe ID of the parameter. Allowed values are:
auValue[out] The value of the parameter.
RXLF_API void Rx::ApiLF::RxGetPar ( Rx::ApiLF::EPar::ID  ePar,
CRxArrayDouble &  adValue 
)

Gets the value of a parameter.

Parameters
eParThe ID of the parameter. Allowed values are:
adValue[out] The value of the parameter.
RXLF_API void Rx::ApiLF::RxGetPar ( Rx::ApiLF::EPar::ID  ePar,
CRxArrayString &  asValue 
)

Gets the value of a parameter.

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

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.
RXLF_API void Rx::ApiLF::RxGetPar ( Rx::ApiLF::EPar::ID  ePar,
unsigned  uIndex,
double &  dValue 
)

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.
RXLF_API void Rx::ApiLF::RxGetPar ( Rx::ApiLF::EPar::ID  ePar,
unsigned  uIndex,
CRxString &  sValue 
)

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.
RXLF_API void Rx::ApiLF::RxGetParName ( EPar::ID  ePar,
Rx::CRxString sValue 
)

Get the string representation of a parameter.

Parameters
eParThe parameter ID. Allowed enums are in Rx::ApiLF::EPar.
[out]sValueOn 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
eParThe parameter ID. Allowed enums are in Rx::ApiLF::EPar.
[out]sValueOn return contains the parameter string representation.
[out]bReadAccessOn return contains the parameter ReadAccess flag.
[out]bWriteAccessOn return contains the parameter WriteAccess flag.
[out]eParameterTypeOn return contains the paramater DataType.
RXLF_API void Rx::ApiLF::RxGetParRange ( Rx::ApiLF::EPar::ID  ePar,
unsigned &  uMin,
unsigned &  uMax 
)

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.
RXLF_API void Rx::ApiLF::RxGetParRange ( Rx::ApiLF::EPar::ID  ePar,
double &  dMin,
double &  dMax 
)

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.
RXLF_API void Rx::ApiLF::RxGetParRange ( Rx::ApiLF::EPar::ID  ePar,
size_t &  iMinCount,
size_t &  iMaxCount,
unsigned &  uMin,
unsigned &  uMax 
)

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.
RXLF_API void Rx::ApiLF::RxGetParRange ( Rx::ApiLF::EPar::ID  ePar,
size_t &  iMinCount,
size_t &  iMaxCount,
double &  dMin,
double &  dMax 
)

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.
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
sxFilenameThe 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:

Halcon Plugin - Function Name:
rx_save_parameter.
Parameters
sxFilenameThe filename.
RXLF_API void Rx::ApiLF::RxSetPar ( Rx::ApiLF::EPar::ID  ePar,
unsigned  uValue 
)

Sets the value of a parameter.

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

Sets the value of a parameter.

Parameters
eParThe ID of the parameter. Allowed values are:
dValue[in] The value of the parameter.
RXLF_API void Rx::ApiLF::RxSetPar ( Rx::ApiLF::EPar::ID  ePar,
const CRxString &  sValue 
)

Sets the value of a parameter.

Parameters
eParThe ID of the parameter. Allowed values are:
sValue[in] The value of the parameter.
RXLF_API void Rx::ApiLF::RxSetPar ( Rx::ApiLF::EPar::ID  ePar,
const CRxArrayUInt &  auValue 
)

Sets the value of a parameter.

Parameters
eParThe ID of the parameter. Allowed values are:
auValue[in] The value of the parameter.
RXLF_API void Rx::ApiLF::RxSetPar ( Rx::ApiLF::EPar::ID  ePar,
const CRxArrayDouble &  adValue 
)

Sets the value of a parameter.

Parameters
eParThe ID of the parameter. Allowed values are:
adValue[in] The value of the parameter.
RXLF_API void Rx::ApiLF::RxSetPar ( Rx::ApiLF::EPar::ID  ePar,
const CRxArrayString &  asValue 
)

Sets the value of a parameter.

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

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.
RXLF_API void Rx::ApiLF::RxSetPar ( Rx::ApiLF::EPar::ID  ePar,
unsigned  uIndex,
double  dValue 
)

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.
RXLF_API void Rx::ApiLF::RxSetPar ( Rx::ApiLF::EPar::ID  ePar,
unsigned  uIndex,
const CRxString &  sValue 
)

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.