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

Functions for working with Raytrix cameras. More...

Functions

RXLF_API void Rx::ApiLF::RxCalibDBBindCalib (const Rx::CRxString &sxGUID, bool bApplyWhiteImage)
 Applies the camera calibration defined by GUID sxGUID to the currently bound image in API. Also updates the computational class. More...
 
RXLF_API void Rx::ApiLF::RxCalibDBBindCalibWhiteImage (unsigned &uRayHandle, const Rx::CRxString &sxGUID)
 Bind white image of calibration to API and use this image as white image too. Now you can calibrate a calibration without using a camera. More...
 
RXLF_API void Rx::ApiLF::RxCalibDBBoundCameraNewCalib (Rx::CRxString &sxNewGUID)
 Creates a new calibration and returns the GUID of the newly created calibration in sxNewGUID. More...
 
RXLF_API void Rx::ApiLF::RxCalibDBCameraNewCalib (Rx::CRxString &sxNewGUID, unsigned uCamIdx)
 Creates a new calibration and returns the GUID of the newly created calibration in sxNewGUID. More...
 
RXLF_API void Rx::ApiLF::RxCalibDBCaptureBoundCalibWhiteImage ()
 Captures 5 image from camera and processes them to one white image that is stored in calibration database in current calibration. More...
 
RXLF_API void Rx::ApiLF::RxCalibDBCaptureCalibWhiteImage (const Rx::CRxString &sxGUID)
 Captures 5 image from camera and processes them to one white image that is stored in calibration database in given calibration. More...
 
RXLF_API void Rx::ApiLF::RxCalibDBCreateDataBase (const Rx::CRxString &sxCamHardwareId, bool bForce)
 Creates a new calibration database for camera with name sxCamHardwareId. More...
 
RXLF_API void Rx::ApiLF::RxCalibDBCreateDataBaseForBoundCamera (bool bForce)
 Creates a new calibration database for bound camera. More...
 
RXLF_API void Rx::ApiLF::RxCalibDBCreateDataBaseForCamera (unsigned uCamIdx, bool bForce)
 Creates a new calibration database for camera with ID uCamIdx. More...
 
RXLF_API void Rx::ApiLF::RxCalibDBDeleteCalib (const Rx::CRxString &sxGUID)
 Deletes camera calibration with GUID sxGUID. More...
 
RXLF_API void Rx::ApiLF::RxCalibDBGetCameraCalibGuidList (Rx::CRxArrayString &asxGUIDs, unsigned uCamIdx)
 Gets a Rx::CRxArrayString which contains unique IDs of all calibration for camera with given index uCamIdx. More...
 
RXLF_API void Rx::ApiLF::RxCalibDBGetCameraMasterCalibGuid (Rx::CRxString &sxGUID, unsigned uCamIdx)
 Gets a Rx::CRxString which contains the GUID of the master calibration of this camera. More...
 
RXLF_API void Rx::ApiLF::RxCalibDBGetCompleteCalibGuidList (Rx::CRxArrayString &asxGUIDs)
 Gets a Rx::CRxArrayString which contains GUIDs of all calibration on this computer. More...
 
RXLF_API void Rx::ApiLF::RxCalibDBGetCompleteMasterCalibGuidList (Rx::CRxArrayString &asxGUIDs)
 Gets a Rx::CRxArrayString which contains GUIDs of all master calibration on this computer. More...
 
RXLF_API void Rx::ApiLF::RxCalibDBLoadBoundCalibMetaData (Rx::CRxCalibMetaData &xCalibData)
 Gets the last applied calibration data. More...
 
RXLF_API void Rx::ApiLF::RxCalibDBLoadCalibMetaData (Rx::CRxCalibMetaData &xCalibData, const Rx::CRxString &sxGUID)
 Gets Rx::CRxCalibMetaData for calibration with given GUID sxGUID. More...
 
RXLF_API void Rx::ApiLF::RxCalibDBNewCalib (Rx::CRxString &sxNewGUID, const Rx::CRxString &sxCamHardwareId)
 Creates a new calibration and returns the GUID of the newly created calibration in sxNewGUID. More...
 
RXLF_API void Rx::ApiLF::RxCalibDBReloadBoundCalib (bool bApplyWhiteImage)
 Applies the currently bound camera calibration to the current bound image in API. Also updates to the computational class. More...
 
RXLF_API void Rx::ApiLF::RxCalibDBSaveBoundCalibMetaData (const Rx::CRxCalibMetaData &xCalibData)
 Sets calibration data to the last applied calibration. More...
 
RXLF_API void Rx::ApiLF::RxCalibDBSaveCalibMetaData (const Rx::CRxCalibMetaData &xCalibData, const Rx::CRxString &sxGUID)
 Sets Rx::CRxCalibMetaData for calibration with given GUID sxGUID. More...
 
RXLF_API void Rx::ApiLF::RxCalibDBUpdateAndSaveBoundCalib ()
 Gets calibration (The camera calibration) from current bound image and saves it to current calibration. Also saves database to disk. More...
 
RXLF_API void Rx::ApiLF::RxCalibDBUpdateAndSaveCalib (const Rx::CRxString &sxGUID)
 Gets (The camera calibration) from current bound image and saves it to the calibration defined by GUID sxGUID. Also saves database to disk. More...
 
RXLF_API unsigned Rx::ApiLF::RxCamBind (unsigned uCamIdx)
 Binds the given camera to the returned API image ID. Call RxCamUnBind to unbind the bound camera. Only one camera can be bound. Calling Rx::ApiLF::RxCamBind with another camera index results in an Rx::ApiLF::CRxApiException. More...
 
RXLF_API void Rx::ApiLF::RxCamClose (unsigned uCamIdx)
 Closes the given camera. If the given camera is currently bound, the camera is unbound before closing. Also, if the camera is in capture mode, the capturing is stopped before unbinding. More...
 
RXLF_API void Rx::ApiLF::RxCamDriverInit ()
 Initialize the camera drivers. More...
 
RXLF_API void Rx::ApiLF::RxCamGetPar (unsigned uCamIdx, EPar::ID ePar, Rx::CRxString &sxValue)
 Get a camera parameter of type Rx::CRxString. More...
 
RXLF_API void Rx::ApiLF::RxCamGetPar (unsigned uCamIdx, EPar::ID ePar, unsigned &uValue)
 Get a camera parameter of type unsigned integer. More...
 
RXLF_API void Rx::ApiLF::RxCamGetPar (unsigned uCamIdx, EPar::ID ePar, double &dValue)
 Get camera parameter of type double. More...
 
RXLF_API void Rx::ApiLF::RxCamGetPar (unsigned uCamIdx, EPar::ID ePar, Rx::CRxArrayString &aValue)
 Get camera parameter of type Rx::CRxArrayString. More...
 
RXLF_API void Rx::ApiLF::RxCamGetPar (EPar::ID ePar, Rx::CRxString &sxValue)
 Get a camera parameter of type Rx::CRxString from the currently bound camera. More...
 
RXLF_API void Rx::ApiLF::RxCamGetPar (EPar::ID ePar, unsigned &uValue)
 Get a camera parameter of type unsigned integer from the currently bound camera. More...
 
RXLF_API void Rx::ApiLF::RxCamGetPar (EPar::ID ePar, double &dValue)
 Get camera parameter of type double from the currently bound camera. More...
 
RXLF_API void Rx::ApiLF::RxCamGetPar (EPar::ID ePar, Rx::CRxArrayString &aValue)
 Get camera parameter of type Rx::CRxArrayString. More...
 
RXLF_API void Rx::ApiLF::RxCamGetParRange (unsigned uCamIdx, EPar::ID ePar, unsigned &uMin, unsigned &uMax)
 Get the parameter range of a camera parameter of type unsigned integer. More...
 
RXLF_API void Rx::ApiLF::RxCamGetParRange (unsigned uCamIdx, EPar::ID ePar, double &dMin, double &dMax)
 Get the parameter range of a camera parameter of type double. More...
 
RXLF_API void Rx::ApiLF::RxCamGetParRange (unsigned uCamIdx, EPar::ID ePar, Rx::CRxArrayUInt &auValues)
 Get a set of available values for a parameter of type unsigned integer. More...
 
RXLF_API void Rx::ApiLF::RxCamGetParRange (EPar::ID ePar, unsigned &uMin, unsigned &uMax)
 Get the parameter range of a camera parameter of type unsigned integer from the currently bound camera. More...
 
RXLF_API void Rx::ApiLF::RxCamGetParRange (EPar::ID ePar, double &dMin, double &dMax)
 Get the parameter range of a camera parameter of type double from the currently bound camera. More...
 
RXLF_API void Rx::ApiLF::RxCamGetParRange (EPar::ID ePar, Rx::CRxArrayUInt &auValues)
 Get set of available values for parameter of type unsigned. More...
 
RXLF_API void Rx::ApiLF::RxCamIsParameterSupported (unsigned uCamIdx, EPar::ID ePar, bool &bSupported)
 Test whether a camera parameter is supported by the selected camera. More...
 
RXLF_API bool Rx::ApiLF::RxCamIsParameterSupported (unsigned uCamIdx, EPar::ID ePar)
 Test whether a camera parameter is supported by the selected camera. More...
 
RXLF_API void Rx::ApiLF::RxCamIsParameterSupported (EPar::ID ePar, bool &bSupported)
 Test whether a camera parameter is supported by the currently bound camera. More...
 
RXLF_API void Rx::ApiLF::RxCamOpen (unsigned uCamIdx)
 Opens the given camera. Camera settings can only be accessed after a camera has been opened. THe first call to open initializes the camera too. More...
 
RXLF_API void Rx::ApiLF::RxCamRegister ()
 Register available cameras. More...
 
RXLF_API void Rx::ApiLF::RxCamRegisterImageCallback (Rx::ApiLF::TFuncCamImageCallback pFunc, void *pvContext)
 Register a callback function which is called when a new image is available. More...
 
RXLF_API void Rx::ApiLF::RxCamRemoveImageCallback ()
 Remove the image callback function. More...
 
RXLF_API bool Rx::ApiLF::RxCamRetrieveImage ()
 Retrieve a single image from the currently bound camera. More...
 
RXLF_API void Rx::ApiLF::RxCamSetPar (unsigned uCamIdx, EPar::ID ePar, const Rx::CRxString &sxValue)
 Set a camera property of type Rx::CRxString. More...
 
RXLF_API void Rx::ApiLF::RxCamSetPar (unsigned uCamIdx, EPar::ID ePar, const unsigned &uValue)
 Set a camera property of type unsigned integer. More...
 
RXLF_API void Rx::ApiLF::RxCamSetPar (unsigned uCamIdx, EPar::ID ePar, const double &dValue)
 Set a camera property of type double. More...
 
RXLF_API void Rx::ApiLF::RxCamSetPar (EPar::ID ePar, const Rx::CRxString &sxValue)
 Set a camera property of type Rx::CRxString from the currently bound camera. More...
 
RXLF_API void Rx::ApiLF::RxCamSetPar (EPar::ID ePar, const unsigned &uValue)
 Set a camera property of type unsigned integer from the currently bound camera. More...
 
RXLF_API void Rx::ApiLF::RxCamSetPar (EPar::ID ePar, const double &dValue)
 Set a camera property of type double. More...
 
RXLF_API void Rx::ApiLF::RxCamStartCapture ()
 Prepares the currently bound camera for capturing images. If the currently bound camera is already in capture mode, then the function throws an exception. More...
 
RXLF_API void Rx::ApiLF::RxCamStopCapture ()
 Stops capturing of the currently bound camera. If the camera is not in capture mode, the function simply returns without error. More...
 
RXLF_API void Rx::ApiLF::RxCamSuspendCapture (bool bSuspend)
 Suspend capturing images. More...
 
RXLF_API void Rx::ApiLF::RxCamTrigger ()
 Triggers capturing of a single image of the currently bound camera. The image can be retrieved by calling Rx::ApiLF::RxCamRetrieveImage. More...
 
RXLF_API void Rx::ApiLF::RxCamUnbind ()
 Unbinds a currently bound camera. If the bound camera is still capturing images, the capturing is stopped and then the camera is unbound. More...
 

Detailed Description

Functions for working with Raytrix cameras.

Function Documentation

RXLF_API void Rx::ApiLF::RxCalibDBBindCalib ( const Rx::CRxString sxGUID,
bool  bApplyWhiteImage 
)

Applies the camera calibration defined by GUID sxGUID to the currently bound image in API. Also updates the computational class.

Halcon Plugin - Function Name:
rx_calibdb_bind_calib
Parameters
sxGUIDGUID of the calibration which should be applied to bound image.
bApplyWhiteImageIf true, the current white image is replaced by the one from the given calibration.
RXLF_API void Rx::ApiLF::RxCalibDBBindCalibWhiteImage ( unsigned &  uRayHandle,
const Rx::CRxString sxGUID 
)

Bind white image of calibration to API and use this image as white image too. Now you can calibrate a calibration without using a camera.

This function returns the image ID of the bound white image in uRayHandle.

Warning
After using this image, you have to delete it to free the memory by calling Rx::ApiLF::RxRayDelete.
Parameters
[out]uRayHandleImage ID of the bound white image.
sxGUIDThe GUID of the calibration.
RXLF_API void Rx::ApiLF::RxCalibDBBoundCameraNewCalib ( Rx::CRxString sxNewGUID)

Creates a new calibration and returns the GUID of the newly created calibration in sxNewGUID.

Parameters
[in]sxNewGUIDUnique identifier for the new calibration.
RXLF_API void Rx::ApiLF::RxCalibDBCameraNewCalib ( Rx::CRxString sxNewGUID,
unsigned  uCamIdx 
)

Creates a new calibration and returns the GUID of the newly created calibration in sxNewGUID.

Parameters
[in]sxNewGUIDUnique identifier for the new calibration.
[in]uCamIdxid of a camera.
RXLF_API void Rx::ApiLF::RxCalibDBCaptureBoundCalibWhiteImage ( )

Captures 5 image from camera and processes them to one white image that is stored in calibration database in current calibration.

RXLF_API void Rx::ApiLF::RxCalibDBCaptureCalibWhiteImage ( const Rx::CRxString sxGUID)

Captures 5 image from camera and processes them to one white image that is stored in calibration database in given calibration.

Parameters
sxGUIDThe GUID of the calibration.
RXLF_API void Rx::ApiLF::RxCalibDBCreateDataBase ( const Rx::CRxString sxCamHardwareId,
bool  bForce 
)

Creates a new calibration database for camera with name sxCamHardwareId.

Warning
If a calibration database for this camera already exists, a new one will only be created if bForce is true. Otherwise a Rx::ApiLF::CRxApiException is thrown.
Parameters
sxCamHardwareIdType of the camera.
bForceFlags whether to overwrite an existing database or not.
RXLF_API void Rx::ApiLF::RxCalibDBCreateDataBaseForBoundCamera ( bool  bForce)

Creates a new calibration database for bound camera.

If a calibration database for this camera already exists, a new one will only be created if bForce is true. Otherwise a Rx::ApiLF::CRxApiException is thrown.

Parameters
bForceFlags whether to overwrite an existing database or not.
RXLF_API void Rx::ApiLF::RxCalibDBCreateDataBaseForCamera ( unsigned  uCamIdx,
bool  bForce 
)

Creates a new calibration database for camera with ID uCamIdx.

If a calibration database for this camera already exists, a new one will only be created if bForce is true. Otherwise a Rx::ApiLF::CRxApiException is thrown.

Parameters
uCamIdxZero-based index of the camera.
bForceFlags whether to overwrite an existing database or not.
RXLF_API void Rx::ApiLF::RxCalibDBDeleteCalib ( const Rx::CRxString sxGUID)

Deletes camera calibration with GUID sxGUID.

Warning
If there is no calibration database for given parameters, an Rx::ApiLF::CRxApiException is thrown.
Parameters
sxGUIDThe GUID of the calibration to delete.
RXLF_API void Rx::ApiLF::RxCalibDBGetCameraCalibGuidList ( Rx::CRxArrayString asxGUIDs,
unsigned  uCamIdx 
)

Gets a Rx::CRxArrayString which contains unique IDs of all calibration for camera with given index uCamIdx.

Parameters
[out]asxGUIDsRx::CRxArrayString of GUIDs.
uCamIdxZero-based index of the camera.
RXLF_API void Rx::ApiLF::RxCalibDBGetCameraMasterCalibGuid ( Rx::CRxString sxGUID,
unsigned  uCamIdx 
)

Gets a Rx::CRxString which contains the GUID of the master calibration of this camera.

Parameters
[out]sxGUIDRx::CRxString of GUID.
uCamIdxZero-based index of the camera.
RXLF_API void Rx::ApiLF::RxCalibDBGetCompleteCalibGuidList ( Rx::CRxArrayString asxGUIDs)

Gets a Rx::CRxArrayString which contains GUIDs of all calibration on this computer.

Halcon Plugin - Function Name:
rx_calibdb_get_complete_calib_guidlist
Parameters
[out]asxGUIDsRx::CRxArrayString of GUIDS.
RXLF_API void Rx::ApiLF::RxCalibDBGetCompleteMasterCalibGuidList ( Rx::CRxArrayString asxGUIDs)

Gets a Rx::CRxArrayString which contains GUIDs of all master calibration on this computer.

Parameters
[out]asxGUIDsRx::CRxArrayString of GUIDS.
RXLF_API void Rx::ApiLF::RxCalibDBLoadBoundCalibMetaData ( Rx::CRxCalibMetaData xCalibData)

Gets the last applied calibration data.

Parameters
[out]xCalibDataInformation describing the calibration.
RXLF_API void Rx::ApiLF::RxCalibDBLoadCalibMetaData ( Rx::CRxCalibMetaData xCalibData,
const Rx::CRxString sxGUID 
)

Gets Rx::CRxCalibMetaData for calibration with given GUID sxGUID.

Parameters
[out]xCalibDataThe calibration data.
sxGUIDThe GUID of the calibration.
RXLF_API void Rx::ApiLF::RxCalibDBNewCalib ( Rx::CRxString sxNewGUID,
const Rx::CRxString sxCamHardwareId 
)

Creates a new calibration and returns the GUID of the newly created calibration in sxNewGUID.

Parameters
[in]sxNewGUIDUnique identifier for the new calibration.
sxCamHardwareIdHardware id of the camera.
RXLF_API void Rx::ApiLF::RxCalibDBReloadBoundCalib ( bool  bApplyWhiteImage)

Applies the currently bound camera calibration to the current bound image in API. Also updates to the computational class.

Precondition
There must be a bound image before calling this function.
Halcon Plugin - Function Name:
rx_calibdb_reload_bound_calib
Parameters
bApplyWhiteImageIf true, the current white image is replaced by the one from the given calibration.
RXLF_API void Rx::ApiLF::RxCalibDBSaveBoundCalibMetaData ( const Rx::CRxCalibMetaData xCalibData)

Sets calibration data to the last applied calibration.

Parameters
xCalibDataInformation describing the calibration.
RXLF_API void Rx::ApiLF::RxCalibDBSaveCalibMetaData ( const Rx::CRxCalibMetaData xCalibData,
const Rx::CRxString sxGUID 
)

Sets Rx::CRxCalibMetaData for calibration with given GUID sxGUID.

Only certain parameters will be considered. The GUID, camera serial and camera type cannot be set.

Parameters
xCalibDataThe calibration data.
sxGUIDThe GUID of the calibration.
RXLF_API void Rx::ApiLF::RxCalibDBUpdateAndSaveBoundCalib ( )

Gets calibration (The camera calibration) from current bound image and saves it to current calibration. Also saves database to disk.

Precondition
There must be a bound image before calling this function.
RXLF_API void Rx::ApiLF::RxCalibDBUpdateAndSaveCalib ( const Rx::CRxString sxGUID)

Gets (The camera calibration) from current bound image and saves it to the calibration defined by GUID sxGUID. Also saves database to disk.

Precondition
There must be a bound image before calling this function.
Parameters
sxGUIDGUID of the calibration which should be saved.
RXLF_API unsigned Rx::ApiLF::RxCamBind ( unsigned  uCamIdx)

Binds the given camera to the returned API image ID. Call RxCamUnBind to unbind the bound camera. Only one camera can be bound. Calling Rx::ApiLF::RxCamBind with another camera index results in an Rx::ApiLF::CRxApiException.

Attention
The internal ray image with ID returned by this function is not deleted from memory when camera is unbound. It has to be deleted explicitly using Rx::ApiLF::RxRayDelete when it is no longer needed.
Precondition
The parameter Rx::ApiLF::CamCap_FrameBuffer_TotalCount should be changed before Rx::ApiLF::RxCamBind is called. Otherwise this parameter has no effect.
Halcon Plugin - Function Name:
rx_cam_bind.
Parameters
uCamIdxZero-based index of the camera.
Returns
The ray image handle of the image into which camera images are captured.
See also
Bind a Camera.
RXLF_API void Rx::ApiLF::RxCamClose ( unsigned  uCamIdx)

Closes the given camera. If the given camera is currently bound, the camera is unbound before closing. Also, if the camera is in capture mode, the capturing is stopped before unbinding.

Halcon Plugin - Function Name:
rx_cam_close.
Parameters
uCamIdxThe zero-based index of the camera to close.
See also
Close a Camera
RXLF_API void Rx::ApiLF::RxCamDriverInit ( )

Initialize the camera drivers.

This function uses the path given in Rx::ApiLF::RxInit as sxLibPath, or the default lib path as stored in the registry, to search for the camera driver DLLs (RaytrixCamera_*.dll), loads and initializes them. This function has to be called before any other Raytrix API camera function.

Halcon Plugin - Function Name:
rx_cam_driver_init.
See also
Prepare a Camera
RXLF_API void Rx::ApiLF::RxCamGetPar ( unsigned  uCamIdx,
EPar::ID  ePar,
Rx::CRxString sxValue 
)

Get a camera parameter of type Rx::CRxString.

Attention
If the parameter referenced by ePar does not relate to a string parameter a Rx::ApiLF::CRxApiException is thrown.
Warning
Not all parameters may be supported by all Raytrix cameras.
Halcon Plugin - Function Name:
rx_cam_get_par_string
Parameters
uCamIdxThe zero-based camera index.
eParThe camera parameter. Allowed parameters from Rx::ApiLF::EPar are:
[out]sxValueThe returned string value.
RXLF_API void Rx::ApiLF::RxCamGetPar ( unsigned  uCamIdx,
EPar::ID  ePar,
unsigned &  uValue 
)

Get a camera parameter of type unsigned integer.

Attention
If the parameter referenced by ePar does not relate to an unsigned integer parameter an Rx::ApiLF::CRxApiException is thrown.
Warning
Not all parameters may be supported by all Raytrix cameras.
Halcon Plugin - Function Name:
rx_cam_get_par_int
Parameters
uCamIdxThe zero-based camera index.
eParThe camera parameter ID. Allowed parameters from Rx::ApiLF::EPar are:
[out]uValueThe returned unsigned integer value.
RXLF_API void Rx::ApiLF::RxCamGetPar ( unsigned  uCamIdx,
EPar::ID  ePar,
double &  dValue 
)

Get camera parameter of type double.

Attention
If the parameter referenced by ePar does not relate to an double parameter an Rx::ApiLF::CRxApiException is thrown.
Warning
Not all parameters may be supported by all Raytrix cameras.
Halcon Plugin - Function Name:
rx_cam_get_par_float
Parameters
uCamIdxThe zero-based camera index.
eParThe camera parameter. Allowed parameters from Rx::ApiLF::EPar are:
[out]dValueThe returned double value.
RXLF_API void Rx::ApiLF::RxCamGetPar ( unsigned  uCamIdx,
EPar::ID  ePar,
Rx::CRxArrayString aValue 
)

Get camera parameter of type Rx::CRxArrayString.

Attention
If the parameter referenced by ePar does not relate to a string-array parameter an Rx::ApiLF::CRxApiException is thrown.
Warning
Not all parameters may be supported by all Raytrix cameras.
Parameters
uCamIdxThe zero-based camera index.
eParThe camera parameter.
[out]aValueThe returned Rx::CRxArrayString value.
RXLF_API void Rx::ApiLF::RxCamGetPar ( EPar::ID  ePar,
Rx::CRxString sxValue 
)

Get a camera parameter of type Rx::CRxString from the currently bound camera.

Attention
If the parameter referenced by ePar does not relate to a string parameter an Rx::ApiLF::CRxApiException is thrown.
Warning
Not all parameters may be supported by all Raytrix cameras.
Halcon Plugin - Function Name:
rx_cam_get_par_string
Parameters
eParThe camera parameter. Allowed parameters from Rx::ApiLF::EPar are:
[out]sxValueThe returned string value.
RXLF_API void Rx::ApiLF::RxCamGetPar ( EPar::ID  ePar,
unsigned &  uValue 
)

Get a camera parameter of type unsigned integer from the currently bound camera.

Attention
If the parameter referenced by ePar does not relate to an unsigned integer parameter an Rx::ApiLF::CRxApiException is thrown.
Warning
Not all parameters may be supported by all Raytrix cameras.
Halcon Plugin - Function Name:
rx_cam_get_par_int
Parameters
eParThe camera parameter. Allowed parameters from Rx::ApiLF::EPar are:
[out]uValueThe returned unsigned integer value.
RXLF_API void Rx::ApiLF::RxCamGetPar ( EPar::ID  ePar,
double &  dValue 
)

Get camera parameter of type double from the currently bound camera.

Attention
If the parameter referenced by ePar does not relate to an double parameter an Rx::ApiLF::CRxApiException is thrown.
Warning
Not all parameters may be supported by all Raytrix cameras.
Halcon Plugin - Function Name:
rx_cam_get_par_float
Parameters
eParThe camera parameter ID. Allowed parameters from Rx::ApiLF::EPar are:
[out]dValueThe returned double value.
RXLF_API void Rx::ApiLF::RxCamGetPar ( EPar::ID  ePar,
Rx::CRxArrayString aValue 
)

Get camera parameter of type Rx::CRxArrayString.

Attention
If the parameter referenced by ePar does not relate to an string-array parameter an Rx::ApiLF::CRxApiException is thrown.
Warning
Not all parameters may be supported by all Raytrix cameras.
Parameters
eParThe camera parameter.
[out]aValueThe returned Rx::CRxArrayString value.
RXLF_API void Rx::ApiLF::RxCamGetParRange ( unsigned  uCamIdx,
EPar::ID  ePar,
unsigned &  uMin,
unsigned &  uMax 
)

Get the parameter range of a camera parameter of type unsigned integer.

Halcon Plugin - Function Name:
rx_cam_get_par_range_int
Parameters
uCamIdxThe zero-based camera index.
eParThe camera parameter. Allowed parameters from Rx::ApiLF::EPar are:
[out]uMinOn return the minimal parameter value.
[out]uMaxOn return the maximal parameter value.
RXLF_API void Rx::ApiLF::RxCamGetParRange ( unsigned  uCamIdx,
EPar::ID  ePar,
double &  dMin,
double &  dMax 
)

Get the parameter range of a camera parameter of type double.

Halcon Plugin - Function Name:
rx_cam_get_par_range_float
Parameters
uCamIdxThe zero-based camera index.
eParThe camera parameter. Allowed parameters from Rx::ApiLF::EPar are:
[out]dMinOn return the minimal parameter value.
[out]dMaxOn return the maximal parameter value.
RXLF_API void Rx::ApiLF::RxCamGetParRange ( unsigned  uCamIdx,
EPar::ID  ePar,
Rx::CRxArrayUInt auValues 
)

Get a set of available values for a parameter of type unsigned integer.

Halcon Plugin - Function Name:
rx_cam_get_par_range_int
Parameters
uCamIdxThe zero-based camera index.
eParThe camera parameter.
[out]auValuesThe list of available values.
RXLF_API void Rx::ApiLF::RxCamGetParRange ( EPar::ID  ePar,
unsigned &  uMin,
unsigned &  uMax 
)

Get the parameter range of a camera parameter of type unsigned integer from the currently bound camera.

Halcon Plugin - Function Name:
rx_cam_get_par_range_int
Parameters
eParThe camera parameter. Allowed parameters from Rx::ApiLF::EPar are:
[out]uMinOn return the minimal parameter value.
[out]uMaxOn return the maximal parameter value.
RXLF_API void Rx::ApiLF::RxCamGetParRange ( EPar::ID  ePar,
double &  dMin,
double &  dMax 
)

Get the parameter range of a camera parameter of type double from the currently bound camera.

Halcon Plugin - Function Name:
rx_cam_get_par_range_flaot
Parameters
eParThe camera parameter. Allowed parameters from Rx::ApiLF::EPar are:
[out]dMinOn return the minimal parameter value.
[out]dMaxOn return the maximal parameter value.
RXLF_API void Rx::ApiLF::RxCamGetParRange ( EPar::ID  ePar,
Rx::CRxArrayUInt auValues 
)

Get set of available values for parameter of type unsigned.

Halcon Plugin - Function Name:
rx_cam_get_par_range_int
Parameters
eParThe camera parameter.
[out]auValuesThe list of available values.
RXLF_API void Rx::ApiLF::RxCamIsParameterSupported ( unsigned  uCamIdx,
EPar::ID  ePar,
bool &  bSupported 
)

Test whether a camera parameter is supported by the selected camera.

Attention
All camera and camera calibration parameters can be tested with this function. Use this function to test whether certain parameters are available or not. For example, the parameters: EPar::Cam_Focus, EPar::Cam_Iris, EPar::Cam_Func_CalibMainLens are only available if a camera is attached that allows the direct control of the main lens.
Halcon Plugin - Function Name:
rx_cam_is_parameter_supported
Parameters
uCamIdxThe zero-based camera index.
eParThe camera parameter ID.
[out]bSupportedOn return indicates whether the parameter ePar is supported or not.
RXLF_API bool Rx::ApiLF::RxCamIsParameterSupported ( unsigned  uCamIdx,
EPar::ID  ePar 
)

Test whether a camera parameter is supported by the selected camera.

Attention
All camera and camera calibration parameters can be tested with this function. Use this function to test whether certain parameters are available or not. For example, the parameters: EPar::Cam_Focus, EPar::Cam_Iris, EPar::Cam_Func_CalibMainLens are only available if a camera is attached that allows the direct control of the main lens.
Halcon Plugin - Function Name:
rx_cam_is_parameter_supported
Parameters
uCamIdxThe zero-based camera index.
eParThe camera parameter ID.
Returns
True if the parameter is supported, otherwise false.
RXLF_API void Rx::ApiLF::RxCamIsParameterSupported ( EPar::ID  ePar,
bool &  bSupported 
)

Test whether a camera parameter is supported by the currently bound camera.

Attention
All camera and camera calibration parameters can be tested with this function. Use this function to test whether certain parameters are available or not. For example, the parameters Rx::ApiLF::EPar::Cam_Focus, Rx::ApiLF::EPar::Cam_Iris and Rx::ApiLF::EPar::Cam_Func_CalibMainLens are only available if a camera is attached that allows the direct control of the main lens.
Halcon Plugin - Function Name:
rx_cam_is_parameter_supported
Parameters
eParThe camera parameter.
[in,out]bSupportedOn return indicates whether the parameter ePar is supported or not.
RXLF_API void Rx::ApiLF::RxCamOpen ( unsigned  uCamIdx)

Opens the given camera. Camera settings can only be accessed after a camera has been opened. THe first call to open initializes the camera too.

Warning
If initialization fails, an Rx::ApiLF::CRxApiException is thrown that holds the reason of failure.
Halcon Plugin - Function Name:
rx_cam_open.
Parameters
uCamIdxThe zero-based index of the camera to open.
See also
Open a Camera
RXLF_API void Rx::ApiLF::RxCamRegister ( )

Register available cameras.

This functions registers all cameras that are currently available. Only registered cameras can be used by the Raytrix API. This function can be called repeatedly to update the list of available cameras. This function has to be called after Rx::ApiLF::RxCamDriverInit and before any other API camera functions.

Halcon Plugin - Function Name:
rx_cam_register.
See also
Prepare a Camera
RXLF_API void Rx::ApiLF::RxCamRegisterImageCallback ( Rx::ApiLF::TFuncCamImageCallback  pFunc,
void *  pvContext 
)

Register a callback function which is called when a new image is available.

Parameters
pFuncThe callback function pointer.
[in,out]pvContextThe void pointer of the Context
RXLF_API void Rx::ApiLF::RxCamRemoveImageCallback ( )

Remove the image callback function.

RXLF_API bool Rx::ApiLF::RxCamRetrieveImage ( )

Retrieve a single image from the currently bound camera.

Attention
This function only returns after an image has been retrieved by the camera and is available on the CUDA device. The camera image is retrieved into the image referenced by the ray image handle returned by the function Rx::ApiLF::RxCamBind. It is also automatically copied onto the CUDA device, so that all processing of the light field image can be done purely on the CUDA device without repeated copying of the light-field image from host to device memory.
Halcon Plugin - Function Name:
rx_cam_retrieve_image.
Returns
true if an image was available, false otherwise.
See also
Retrieve Images from a Raytrix Camera
RXLF_API void Rx::ApiLF::RxCamSetPar ( unsigned  uCamIdx,
EPar::ID  ePar,
const Rx::CRxString sxValue 
)

Set a camera property of type Rx::CRxString.

Attention
If the parameter referenced by ePar does not relate to an unsigned integer parameter an Rx::ApiLF::CRxApiException is thrown.
Warning
Not all parameters may be supported by all Raytrix cameras.
Halcon Plugin - Function Name:
rx_cam_set_par_string
Parameters
uCamIdxThe zero-based camera index.
eParThe camera parameter. Allowed parameters from Rx::ApiLF::EPar are:
sxValueThe string value.
RXLF_API void Rx::ApiLF::RxCamSetPar ( unsigned  uCamIdx,
EPar::ID  ePar,
const unsigned &  uValue 
)

Set a camera property of type unsigned integer.

Attention
If the parameter referenced by ePar does not relate to an unsigned integer parameter an Rx::ApiLF::CRxApiException is thrown.
Warning
Not all parameters may be supported by all Raytrix cameras.
Halcon Plugin - Function Name:
rx_cam_set_par_int
Parameters
uCamIdxThe zero-based camera index.
eParThe camera parameter. Allowed parameters from Rx::ApiLF::EPar are:
uValueThe unsigned integer value.
RXLF_API void Rx::ApiLF::RxCamSetPar ( unsigned  uCamIdx,
EPar::ID  ePar,
const double &  dValue 
)

Set a camera property of type double.

Attention
If the parameter referenced by ePar does not relate to an double parameter an Rx::ApiLF::CRxApiException is thrown.
Warning
Not all parameters may be supported by all Raytrix cameras.
Halcon Plugin - Function Name:
rx_cam_set_par_float
Parameters
uCamIdxThe zero-based camera index.
eParThe camera parameter. Allowed parameters from Rx::ApiLF::EPar are:
dValueThe double value.
RXLF_API void Rx::ApiLF::RxCamSetPar ( EPar::ID  ePar,
const Rx::CRxString sxValue 
)

Set a camera property of type Rx::CRxString from the currently bound camera.

Attention
If the parameter referenced by ePar does not relate to an unsigned integer parameter an Rx::ApiLF::CRxApiException is thrown.
Warning
Not all parameters may be supported by all Raytrix cameras.
Halcon Plugin - Function Name:
rx_cam_set_par_string
Parameters
eParThe camera parameter. Allowed parameters from Rx::ApiLF::EPar are:
sxValueThe string value.
RXLF_API void Rx::ApiLF::RxCamSetPar ( EPar::ID  ePar,
const unsigned &  uValue 
)

Set a camera property of type unsigned integer from the currently bound camera.

Attention
If the parameter referenced by ePar does not relate to an unsigned integer parameter an Rx::ApiLF::CRxApiException is thrown.
Warning
Not all parameters may be supported by all Raytrix cameras.
Halcon Plugin - Function Name:
rx_cam_set_par_int
Parameters
eParThe camera parameter. Allowed parameters from Rx::ApiLF::EPar are:
uValueThe unsigned integer value.
RXLF_API void Rx::ApiLF::RxCamSetPar ( EPar::ID  ePar,
const double &  dValue 
)

Set a camera property of type double.

Attention
If the parameter referenced by ePar does not relate to an double parameter an Rx::ApiLF::CRxApiException is thrown.
Warning
Not all parameters may be supported by all Raytrix cameras.
Halcon Plugin - Function Name:
rx_cam_set_par_float
Parameters
eParThe camera parameter. Allowed parameters from Rx::ApiLF::EPar are:
dValueThe double value.
RXLF_API void Rx::ApiLF::RxCamStartCapture ( )

Prepares the currently bound camera for capturing images. If the currently bound camera is already in capture mode, then the function throws an exception.

Attention
Calling this function does not actually capture any images but prepares the camera for capturing images. The function also reads the calibration data of the currently bound camera from the path set as sxCalibPath in Rx::ApiLF::RxInit.
Halcon Plugin - Function Name:
rx_cam_start_capture.
See also
Start the capture process of a Camera
RXLF_API void Rx::ApiLF::RxCamStopCapture ( )

Stops capturing of the currently bound camera. If the camera is not in capture mode, the function simply returns without error.

Halcon Plugin - Function Name:
rx_cam_stop_capture.
See also
Start the capture process of a Camera
RXLF_API void Rx::ApiLF::RxCamSuspendCapture ( bool  bSuspend)

Suspend capturing images.

This function stops the data transfer between camera and computer but keeps all other capture settings.

Halcon Plugin - Function Name:
rx_cam_suspend_capture.
Parameters
bSuspendTrue to suspend camera capture and false to restart camera capture.
See also
Start the capture process of a Camera
RXLF_API void Rx::ApiLF::RxCamTrigger ( )

Triggers capturing of a single image of the currently bound camera. The image can be retrieved by calling Rx::ApiLF::RxCamRetrieveImage.

Halcon Plugin - Function Name:
rx_cam_trigger.
See also
Retrieve Images from a Raytrix Camera
RXLF_API void Rx::ApiLF::RxCamUnbind ( )

Unbinds a currently bound camera. If the bound camera is still capturing images, the capturing is stopped and then the camera is unbound.

Halcon Plugin - Function Name:
rx_cam_unbind.
See also
Unbind a Camera