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... | |
Functions for working with Raytrix cameras.
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.
sxGUID | GUID of the calibration which should be applied to bound image. |
bApplyWhiteImage | If 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
.
[out] | uRayHandle | Image ID of the bound white image. |
sxGUID | The 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
.
[in] | sxNewGUID | Unique 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
.
[in] | sxNewGUID | Unique identifier for the new calibration. |
[in] | uCamIdx | id 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.
sxGUID | The 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
.
bForce
is true
. Otherwise a Rx::ApiLF::CRxApiException is thrown.sxCamHardwareId | Type of the camera. |
bForce | Flags 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.
bForce | Flags 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.
uCamIdx | Zero-based index of the camera. |
bForce | Flags whether to overwrite an existing database or not. |
RXLF_API void Rx::ApiLF::RxCalibDBDeleteCalib | ( | const Rx::CRxString & | sxGUID | ) |
Deletes camera calibration with GUID sxGUID
.
sxGUID | The 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
.
[out] | asxGUIDs | Rx::CRxArrayString of GUIDs. |
uCamIdx | Zero-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.
[out] | sxGUID | Rx::CRxString of GUID. |
uCamIdx | Zero-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.
[out] | asxGUIDs | Rx::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.
[out] | asxGUIDs | Rx::CRxArrayString of GUIDS. |
RXLF_API void Rx::ApiLF::RxCalibDBLoadBoundCalibMetaData | ( | Rx::CRxCalibMetaData & | xCalibData | ) |
Gets the last applied calibration data.
[out] | xCalibData | Information 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
.
[out] | xCalibData | The calibration data. |
sxGUID | The 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
.
[in] | sxNewGUID | Unique identifier for the new calibration. |
sxCamHardwareId | Hardware 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.
bApplyWhiteImage | If 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.
xCalibData | Information 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.
xCalibData | The calibration data. |
sxGUID | The 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.
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.
sxGUID | GUID 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.
uCamIdx | Zero-based index of the 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.
uCamIdx | The zero-based index of the camera to close. |
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.
RXLF_API void Rx::ApiLF::RxCamGetPar | ( | unsigned | uCamIdx, |
EPar::ID | ePar, | ||
Rx::CRxString & | sxValue | ||
) |
Get a camera parameter of type Rx::CRxString
.
uCamIdx | The zero-based camera index. | |
ePar | The camera parameter. Allowed parameters from Rx::ApiLF::EPar are: | |
[out] | sxValue | The returned string value. |
RXLF_API void Rx::ApiLF::RxCamGetPar | ( | unsigned | uCamIdx, |
EPar::ID | ePar, | ||
unsigned & | uValue | ||
) |
Get a camera parameter of type unsigned
integer
.
uCamIdx | The zero-based camera index. | |
ePar | The camera parameter ID. Allowed parameters from Rx::ApiLF::EPar are:
| |
[out] | uValue | The returned unsigned integer value. |
RXLF_API void Rx::ApiLF::RxCamGetPar | ( | unsigned | uCamIdx, |
EPar::ID | ePar, | ||
double & | dValue | ||
) |
Get camera parameter of type double
.
uCamIdx | The zero-based camera index. | |
ePar | The camera parameter. Allowed parameters from Rx::ApiLF::EPar are:
| |
[out] | dValue | The returned double value. |
RXLF_API void Rx::ApiLF::RxCamGetPar | ( | unsigned | uCamIdx, |
EPar::ID | ePar, | ||
Rx::CRxArrayString & | aValue | ||
) |
Get camera parameter of type Rx::CRxArrayString
.
uCamIdx | The zero-based camera index. | |
ePar | The camera parameter. | |
[out] | aValue | The 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.
ePar | The camera parameter. Allowed parameters from Rx::ApiLF::EPar are: | |
[out] | sxValue | The 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.
ePar | The camera parameter. Allowed parameters from Rx::ApiLF::EPar are:
| |
[out] | uValue | The 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.
ePar | The camera parameter ID. Allowed parameters from Rx::ApiLF::EPar are:
| |
[out] | dValue | The returned double value. |
RXLF_API void Rx::ApiLF::RxCamGetPar | ( | EPar::ID | ePar, |
Rx::CRxArrayString & | aValue | ||
) |
Get camera parameter of type Rx::CRxArrayString
.
ePar | The camera parameter. | |
[out] | aValue | The 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
.
uCamIdx | The zero-based camera index. | |
ePar | The camera parameter. Allowed parameters from Rx::ApiLF::EPar are: | |
[out] | uMin | On return the minimal parameter value. |
[out] | uMax | On 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
.
uCamIdx | The zero-based camera index. | |
ePar | The camera parameter. Allowed parameters from Rx::ApiLF::EPar are: | |
[out] | dMin | On return the minimal parameter value. |
[out] | dMax | On 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
.
uCamIdx | The zero-based camera index. | |
ePar | The camera parameter. | |
[out] | auValues | The 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.
ePar | The camera parameter. Allowed parameters from Rx::ApiLF::EPar are: | |
[out] | uMin | On return the minimal parameter value. |
[out] | uMax | On 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.
ePar | The camera parameter. Allowed parameters from Rx::ApiLF::EPar are: | |
[out] | dMin | On return the minimal parameter value. |
[out] | dMax | On 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
ePar | The camera parameter. | |
[out] | auValues | The 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.
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.uCamIdx | The zero-based camera index. | |
ePar | The camera parameter ID. | |
[out] | bSupported | On 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.
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.uCamIdx | The zero-based camera index. |
ePar | The camera parameter ID. |
RXLF_API void Rx::ApiLF::RxCamIsParameterSupported | ( | EPar::ID | ePar, |
bool & | bSupported | ||
) |
Test whether a camera parameter is supported by the currently bound camera.
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.ePar | The camera parameter. | |
[in,out] | bSupported | On 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.
uCamIdx | The zero-based index of the camera to open. |
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.
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.
pFunc | The callback function pointer. | |
[in,out] | pvContext | The 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.
true
if an image was available, false
otherwise.RXLF_API void Rx::ApiLF::RxCamSetPar | ( | unsigned | uCamIdx, |
EPar::ID | ePar, | ||
const Rx::CRxString & | sxValue | ||
) |
Set a camera property of type Rx::CRxString
.
uCamIdx | The zero-based camera index. |
ePar | The camera parameter. Allowed parameters from Rx::ApiLF::EPar are: |
sxValue | The string value. |
RXLF_API void Rx::ApiLF::RxCamSetPar | ( | unsigned | uCamIdx, |
EPar::ID | ePar, | ||
const unsigned & | uValue | ||
) |
Set a camera property of type unsigned
integer
.
uCamIdx | The zero-based camera index. |
ePar | The camera parameter. Allowed parameters from Rx::ApiLF::EPar are: |
uValue | The unsigned integer value. |
RXLF_API void Rx::ApiLF::RxCamSetPar | ( | unsigned | uCamIdx, |
EPar::ID | ePar, | ||
const double & | dValue | ||
) |
Set a camera property of type double
.
uCamIdx | The zero-based camera index. |
ePar | The camera parameter. Allowed parameters from Rx::ApiLF::EPar are: |
dValue | The 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.
ePar | The camera parameter. Allowed parameters from Rx::ApiLF::EPar are: |
sxValue | The 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.
ePar | The camera parameter. Allowed parameters from Rx::ApiLF::EPar are: |
uValue | The unsigned integer value. |
RXLF_API void Rx::ApiLF::RxCamSetPar | ( | EPar::ID | ePar, |
const double & | dValue | ||
) |
Set a camera property of type double
.
ePar | The camera parameter. Allowed parameters from Rx::ApiLF::EPar are: |
dValue | The 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.
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.
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.
bSuspend | True to suspend camera capture and false to restart camera capture. |
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.
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.