Functions for working with Raytrix cameras. More...
Functions | |
delegate void | Rx::Net::ApiLF::CamImageAvailableHandler (unsigned uCamIdx) |
Handler, called when the camera image available. More... | |
delegate void | Rx::Net::ApiLF::CamImageCallbackHandler (unsigned uCamIdx, void *pvContext) |
static void | Rx::Net::ApiLF::RxCalibDBBindCalib (System::String^ sGUID, bool bApplyWhiteImage) |
Applies calibration (The camera calibration) defined by GUID sGUID to the currently bound image in API. Also updates the computational class. More... | |
static void | Rx::Net::ApiLF::RxCalibDBBindCalibWhiteImage ([Out] unsigned% uImgID, System::String^ sGUID) |
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... | |
static System::String^ | Rx::Net::ApiLF::RxCalibDBBoundCameraNewCalib () |
Creates a new calibration. More... | |
static System::String^ | Rx::Net::ApiLF::RxCalibDBCameraNewCalib (unsigned uCamIdx) |
Creates a new calibration. More... | |
static void | Rx::Net::ApiLF::RxCalibDBCaptureBoundCalibWhiteImage () |
Captures 5 image from camera and processes them to one white image that is stored in calibration database in current calibration. More... | |
static void | Rx::Net::ApiLF::RxCalibDBCaptureCalibWhiteImage (System::String^ sGUID) |
Captures 5 image from camera and processes them to one white image that is stored in calibration database in given calibration. More... | |
static void | Rx::Net::ApiLF::RxCalibDBCreateDataBase (System::String^ sCamHardwareId, bool bForce) |
Creates a new calibration database for camera with name sxCamHardwareId . More... | |
static void | Rx::Net::ApiLF::RxCalibDBCreateDataBaseForBoundCamera (bool bForce) |
Creates a new calibration database for bound camera. More... | |
static void | Rx::Net::ApiLF::RxCalibDBCreateDataBaseForCamera (unsigned uCamIdx, bool bForce) |
Creates a new calibration database for camera with ID uCamIdx . More... | |
static void | Rx::Net::ApiLF::RxCalibDBDeleteCalib (System::String^ sGUID) |
Deletes camera calibration with GUID sGUID . More... | |
static void | Rx::Net::ApiLF::RxCalibDBGetCameraCalibGuidList ([Out] array< System::String^ >^%asGUIDs, unsigned uCamIdx) |
Gets an array which contains unique IDs of all calibration for camera with given index uCamIdx . More... | |
static void | Rx::Net::ApiLF::RxCalibDBGetCameraMasterCalibGuid ([Out] System::String^ %sGUID, unsigned uCamIdx) |
Gets a string which contains the GUID of the master calibration of this camera. More... | |
static void | Rx::Net::ApiLF::RxCalibDBGetCompleteCalibGuidList ([Out] array< System::String^ >^%asGUIDs) |
Gets a array which contains GUIDs of all calibration on this computer. More... | |
static void | Rx::Net::ApiLF::RxCalibDBGetCompleteMasterCalibGuidList ([Out] array< System::String^ >^%asGUIDs) |
Gets a string array which contains GUIDs of all master calibration on this computer. More... | |
static void | Rx::Net::ApiLF::RxCalibDBLoadBoundCalibMetaData ([Out] Rx::Net::CalibMetaData^ %xCalibData) |
Gets the last applied calibration data. More... | |
static void | Rx::Net::ApiLF::RxCalibDBLoadCalibMetaData ([Out] Rx::Net::CalibMetaData^ %xCalibData, System::String^ sGUID) |
Gets Rx::Net::CalibMetaData for calibration with given GUID sGUID . More... | |
static System::String^ | Rx::Net::ApiLF::RxCalibDBNewCalib (System::String^ sCamHardwareId) |
Creates a new calibration and returns the GUID of the newly created calibration. More... | |
static void | Rx::Net::ApiLF::RxCalibDBReloadBoundCalib (bool bApplyWhiteImage) |
Applies the currently bound camera calibration to the current bound image in API. Also updates to the computational class. More... | |
static void | Rx::Net::ApiLF::RxCalibDBSaveBoundCalibMetaData (Rx::Net::CalibMetaData^ xCalibData) |
Sets calibration data to the last applied calibration. More... | |
static void | Rx::Net::ApiLF::RxCalibDBSaveCalibMetaData (Rx::Net::CalibMetaData^ xCalibData, System::String^ sGUID) |
Sets Rx::Net::CalibMetaData for calibration with given GUID sGUID . More... | |
static void | Rx::Net::ApiLF::RxCalibDBUpdateAndSaveBoundCalib () |
Gets calibration (The camera calibration) from current bound image and saves it to current calibration. Also saves database to disk. More... | |
static void | Rx::Net::ApiLF::RxCalibDBUpdateAndSaveCalib (System::String^ sGUID) |
Gets (The camera calibration) from current bound image and saves it to the calibration defined by GUID sGUID . Also saves database to disk. More... | |
static unsigned | Rx::Net::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::Net::ApiLF::RxCamBind with another camera index results in an Rx::Net::ApiLF::CRxApiException. More... | |
static void | Rx::Net::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... | |
static void | Rx::Net::ApiLF::RxCamDriverInit () |
Initialize the camera drivers. More... | |
static void | Rx::Net::ApiLF::RxCamGetPar (unsigned uCamIdx, Rx::Net::ApiLF::EPar ePar, [Out] System::String^ %sValue) |
Get a camera parameter of type String . More... | |
static void | Rx::Net::ApiLF::RxCamGetPar (unsigned uCamIdx, Rx::Net::ApiLF::EPar ePar, [Out] unsigned% uValue) |
Get a camera parameter of type unsigned integer . More... | |
static void | Rx::Net::ApiLF::RxCamGetPar (unsigned uCamIdx, Rx::Net::ApiLF::EPar ePar, [Out] double% dValue) |
Get camera parameter of type double . More... | |
static void | Rx::Net::ApiLF::RxCamGetPar (unsigned uCamIdx, Rx::Net::ApiLF::EPar ePar, [Out] array< System::String^ >^%aValue) |
Get camera parameter of type 'string []'. More... | |
static void | Rx::Net::ApiLF::RxCamGetPar (Rx::Net::ApiLF::EPar ePar, [Out] System::String^ %sValue) |
Get a camera parameter of type String from the currently bound camera. More... | |
static void | Rx::Net::ApiLF::RxCamGetPar (Rx::Net::ApiLF::EPar ePar, [Out] unsigned% uValue) |
Get a camera parameter of type unsigned from the currently bound camera. More... | |
static void | Rx::Net::ApiLF::RxCamGetPar (Rx::Net::ApiLF::EPar ePar, [Out] double% dValue) |
Get camera parameter of type double from the currently bound camera. More... | |
static void | Rx::Net::ApiLF::RxCamGetPar (Rx::Net::ApiLF::EPar ePar, [Out] array< System::String^ >^%aValue) |
Get camera parameter of type string array. More... | |
static void | Rx::Net::ApiLF::RxCamGetParRange (unsigned uCamIdx, Rx::Net::ApiLF::EPar ePar, [Out] unsigned% uMin, [Out] unsigned% uMax) |
Get the parameter range of a camera parameter of type unsigned integer . More... | |
static void | Rx::Net::ApiLF::RxCamGetParRange (unsigned uCamIdx, Rx::Net::ApiLF::EPar ePar, [Out] double% dMin, [Out] double% dMax) |
Get the parameter range of a camera parameter of type double . More... | |
static void | Rx::Net::ApiLF::RxCamGetParRange (unsigned uCamIdx, Rx::Net::ApiLF::EPar ePar, [Out] array< unsigned >^%auValues) |
Get a set of available values for a parameter of type unsigned array. More... | |
static void | Rx::Net::ApiLF::RxCamGetParRange (Rx::Net::ApiLF::EPar ePar, [Out] unsigned% uMin, [Out] unsigned% uMax) |
Get the parameter range of a camera parameter of type unsigned integer from the currently bound camera. More... | |
static void | Rx::Net::ApiLF::RxCamGetParRange (Rx::Net::ApiLF::EPar ePar, [Out] double% dMin, [Out] double% dMax) |
Get the parameter range of a camera parameter of type double from the currently bound camera. More... | |
static void | Rx::Net::ApiLF::RxCamGetParRange (Rx::Net::ApiLF::EPar ePar, [Out] array< unsigned >^%auValues) |
Get set of available values for parameter of type uint []. More... | |
static void | Rx::Net::ApiLF::RxCamIsParameterSupported (unsigned uCamIdx, Rx::Net::ApiLF::EPar ePar, [Out] bool% bSupported) |
Test whether a camera parameter is supported by the selected camera. More... | |
static bool | Rx::Net::ApiLF::RxCamIsParameterSupported (unsigned uCamIdx, Rx::Net::ApiLF::EPar ePar) |
Test whether a camera parameter is supported by the selected camera. More... | |
static void | Rx::Net::ApiLF::RxCamIsParameterSupported (Rx::Net::ApiLF::EPar ePar, [Out] bool% bSupported) |
Test whether a camera parameter is supported by the currently bound camera. More... | |
static bool | Rx::Net::ApiLF::RxCamIsParameterSupported (Rx::Net::ApiLF::EPar ePar) |
Test whether a camera parameter is supported by the currently bound camera. More... | |
static void | Rx::Net::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... | |
static void | Rx::Net::ApiLF::RxCamRegister () |
Register available cameras. More... | |
static bool | Rx::Net::ApiLF::RxCamRetrieveImage () |
Retrieve a single image from the currently bound camera. More... | |
static void | Rx::Net::ApiLF::RxCamSetPar (unsigned uCamIdx, Rx::Net::ApiLF::EPar ePar, System::String^ sValue) |
Set a camera property of type String . More... | |
static void | Rx::Net::ApiLF::RxCamSetPar (unsigned uCamIdx, Rx::Net::ApiLF::EPar ePar, unsigned uValue) |
Set a camera property of type unsigned integer . More... | |
static void | Rx::Net::ApiLF::RxCamSetPar (unsigned uCamIdx, Rx::Net::ApiLF::EPar ePar, double dValue) |
Set a camera property of type double . More... | |
static void | Rx::Net::ApiLF::RxCamSetPar (Rx::Net::ApiLF::EPar ePar, System::String^ sValue) |
Set a camera property of type String from the currently bound camera. More... | |
static void | Rx::Net::ApiLF::RxCamSetPar (Rx::Net::ApiLF::EPar ePar, unsigned uValue) |
Set a camera property of type unsigned integer from the currently bound camera. More... | |
static void | Rx::Net::ApiLF::RxCamSetPar (Rx::Net::ApiLF::EPar ePar, double dValue) |
Set a camera property of type double . More... | |
static void | Rx::Net::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... | |
static void | Rx::Net::ApiLF::RxCamStopCapture () |
Stops capturing of the currently bound camera. If the camera is not in capture mode, the function simply returns without error. More... | |
static void | Rx::Net::ApiLF::RxCamSuspendCapture (bool bSuspend) |
Suspend capturing images. This function stops the data transfer between camera and computer but keeps all other capture settings. More... | |
static void | Rx::Net::ApiLF::RxCamTrigger () |
Triggers capturing of a single image of the currently bound camera. The image can be retrieved by calling Rx::Net::ApiLF::RxCamRetrieveImage. More... | |
static void | Rx::Net::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... | |
Events | |
static CamImageAvailableHandler^ | Rx::Net::ApiLF::CamImageAvailable [add, remove, raise] |
Event queue for all listeners interested in CamImageAvailable events. More... | |
Functions for working with Raytrix cameras.
delegate void Rx::Net::ApiLF::CamImageAvailableHandler | ( | unsigned | uCamIdx | ) |
Handler, called when the camera image available.
uCamIdx | Zero-based index of the camera. |
delegate void Rx::Net::ApiLF::CamImageCallbackHandler | ( | unsigned | uCamIdx, |
void * | pvContext | ||
) |
|
static |
Applies calibration (The camera calibration) defined by GUID sGUID
to the currently bound image in API. Also updates the computational class.
[in] | sGUID | 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. |
|
static |
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 uImgID.
[out] | uImgID | Image ID of the bound white image. |
[in] | sGUID | The GUID of the calibration. |
|
static |
Creates a new calibration.
|
static |
Creates a new calibration.
uCamIdx | id of a camera. |
|
static |
Captures 5
image from camera and processes them to one white image that is stored in calibration database in current calibration.
|
static |
Captures 5
image from camera and processes them to one white image that is stored in calibration database in given calibration.
[in] | sGUID | The GUID of the calibration. |
|
static |
Creates a new calibration database for camera with name sxCamHardwareId
.
If a calibration database for this camera already exists, a new one will only be created if bForce
is true
. Otherwise a Rx::Net::RxException is thrown.
[in] | sCamHardwareId | Type of the camera. |
bForce | Flags whether to overwrite an existing database or not. |
|
static |
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::Net::ApiLF::CRxApiException is thrown.
bForce | Flags whether to overwrite an existing database or not. |
|
static |
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 an Rx::Net::RxException is thrown.
uCamIdx | Zero-based index of the camera. |
bForce | Flags whether to overwrite an existing database or not. |
|
static |
Deletes camera calibration with GUID sGUID
.
[in] | sGUID | The GUID of the calibration to delete. |
|
static |
Gets an array which contains unique IDs of all calibration for camera with given index uCamIdx
.
[out] | asGUIDs | Array of GUIDs. |
uCamIdx | Zero-based index of the camera. |
|
static |
Gets a string which contains the GUID of the master calibration of this camera.
[out] | sGUID | String of GUID. |
uCamIdx | Zero-based index of the camera. |
|
static |
Gets a array which contains GUIDs of all calibration on this computer.
[out] | asGUIDs | array of GUIDS. |
|
static |
Gets a string array which contains GUIDs of all master calibration on this computer.
[out] | asGUIDs | string array of GUIDS. |
|
static |
Gets the last applied calibration data.
[out] | xCalibData | Information describing the calibration. |
|
static |
Gets Rx::Net::CalibMetaData
for calibration with given GUID sGUID
.
[out] | xCalibData | The calibration data. |
[in] | sGUID | The GUID of the calibration. |
|
static |
Creates a new calibration and returns the GUID of the newly created calibration.
[in] | sCamHardwareId | Unique identifier for the new calibration. |
|
static |
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. |
|
static |
Sets calibration data to the last applied calibration.
[in] | xCalibData | Information describing the calibration. |
|
static |
Sets Rx::Net::CalibMetaData
for calibration with given GUID sGUID
.
Only certain parameters will be considered. The GUID, camera serial and camera type cannot be set.
[in] | xCalibData | The calibration data. |
[in] | sGUID | The GUID of the calibration. |
|
static |
Gets calibration (The camera calibration) from current bound image and saves it to current calibration. Also saves database to disk.
|
static |
Gets (The camera calibration) from current bound image and saves it to the calibration defined by GUID sGUID
. Also saves database to disk.
[in] | sGUID | GUID of the calibration which should be saved. |
|
static |
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::Net::ApiLF::RxCamBind with another camera index results in an Rx::Net::ApiLF::CRxApiException.
uCamIdx | Zero-based index of the camera. |
|
static |
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. |
|
static |
Initialize the camera drivers.
This function uses the path given in Rx::Net::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.
|
static |
Get a camera parameter of type String
.
uCamIdx | The zero-based camera index. | |
ePar | The camera parameter. Allowed parameters from Rx::Net::ApiLF::EPar are: | |
[out] | sValue | The returned string value. |
|
static |
Get a camera parameter of type unsigned
integer
.
uCamIdx | The zero-based camera index. | |
ePar | The camera parameter ID. Allowed parameters from Rx::Net::ApiLF::EPar are:
| |
[out] | uValue | The returned unsigned integer value. |
|
static |
Get camera parameter of type double
.
uCamIdx | The zero-based camera index. | |
ePar | The camera parameter. Allowed parameters from Rx::Net::ApiLF::EPar are:
| |
[out] | dValue | The returned double value. |
|
static |
Get camera parameter of type 'string
[]'.
uCamIdx | The zero-based camera index. | |
ePar | The camera parameter. | |
[out] | aValue | The returned double value. |
|
static |
Get a camera parameter of type String
from the currently bound camera.
ePar | The camera parameter. Allowed parameters from Rx::Net::ApiLF::EPar are: | |
[out] | sValue | The returned string value. |
|
static |
Get a camera parameter of type unsigned
from the currently bound camera.
|
static |
Get camera parameter of type double
from the currently bound camera.
ePar | The camera parameter ID. Allowed parameters from Rx::Net::ApiLF::EPar are:
| |
[out] | dValue | The returned double value. |
|
static |
Get camera parameter of type string
array.
ePar | The camera parameter. | |
[out] | aValue | The returned string array value. |
|
static |
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::Net::ApiLF::EPar are: | |
[out] | uMin | On return the minimal parameter value. |
[out] | uMax | On return the maximal parameter value. |
|
static |
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::Net::ApiLF::EPar are: | |
[out] | dMin | On return the minimal parameter value. |
[out] | dMax | On return the maximal parameter value. |
|
static |
Get a set of available values for a parameter of type unsigned
array.
uCamIdx | The zero-based camera index. | |
ePar | The camera parameter. | |
[out] | auValues | The list of available values. |
|
static |
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::Net::ApiLF::EPar are: | |
[out] | uMin | On return the minimal parameter value. |
[out] | uMax | On return the maximal parameter value. |
|
static |
Get the parameter range of a camera parameter of type double
from the currently bound camera.
ePar | The camera parameter. Allowed parameters from Rx::Net::ApiLF::EPar are: | |
[out] | dMin | On return the minimal parameter value. |
[out] | dMax | On return the maximal parameter value. |
|
static |
Get set of available values for parameter of type uint
[].
ePar | The camera parameter. | |
[out] | auValues | The list of available values. |
|
static |
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. | |
[in] | bSupported | On return indicates whether the parameter ePar is supported or not. |
|
static |
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. |
|
static |
Test whether a camera parameter is supported by the currently bound camera.
ePar | The camera parameter. | |
[out] | bSupported | On return indicates whether the parameter ePar is supported or not. |
|
static |
Test whether a camera parameter is supported by the currently bound camera.
ePar | The camera parameter. |
|
static |
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. |
|
static |
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::Net::ApiLF::RxCamDriverInit and before any other API camera functions.
|
static |
Retrieve a single image from the currently bound camera.
true
if an image was available, false
otherwise.
|
static |
Set a camera property of type String
.
uCamIdx | The zero-based camera index. | |
ePar | The camera parameter. Allowed parameters from Rx::Net::ApiLF::EPar are: | |
[in] | sValue | The returned String value. |
|
static |
Set a camera property of type unsigned
integer
.
uCamIdx | The zero-based camera index. |
ePar | The camera parameter. Allowed parameters from Rx::Net::ApiLF::EPar are: |
uValue | The unsigned integer value. |
|
static |
Set a camera property of type double
.
uCamIdx | The zero-based camera index. |
ePar | The camera parameter. Allowed parameters from Rx::Net::ApiLF::EPar are:
|
dValue | The double value. |
|
static |
Set a camera property of type String
from the currently bound camera.
ePar | The camera parameter. Allowed parameters from Rx::Net::ApiLF::EPar are: | |
[in] | sValue | The string value. |
|
static |
Set a camera property of type unsigned
integer
from the currently bound camera.
ePar | The camera parameter. Allowed parameters from Rx::Net::ApiLF::EPar are: |
uValue | The unsigned integer value. |
|
static |
Set a camera property of type double
.
ePar | The camera parameter. Allowed parameters from Rx::Net::ApiLF::EPar are:
|
dValue | The double value. |
|
static |
Prepares the currently bound camera for capturing images. If the currently bound camera is already in capture mode, then the function throws an exception.
|
static |
Stops capturing of the currently bound camera. If the camera is not in capture mode, the function simply returns without error.
|
static |
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. |
|
static |
Triggers capturing of a single image of the currently bound camera. The image can be retrieved by calling Rx::Net::ApiLF::RxCamRetrieveImage.
|
static |
Unbinds a currently bound camera. If the bound camera is still capturing images, the capturing is stopped and then the camera is unbound.
|
staticaddremoveraise |
Event queue for all listeners interested in CamImageAvailable events.