Mech-Eye API 2.4.0
API reference documentation for Mech-Eye Industrial 3D Camera
|
Classes | |
struct | Transformation |
Defines rigid body transformations, including translation vector and quaternion vector. More... | |
Public Types | |
enum struct | CameraMountingMode { EyeInHand , EyeToHand } |
enum struct | CalibrationBoardModel { BDB_5 , BDB_6 , BDB_7 , OCB_5 , OCB_10 , OCB_15 , OCB_20 , CGB_20 , CGB_35 , CGB_50 } |
Public Member Functions | |
ErrorStatus | initializeCalibration (Camera &camera, CameraMountingMode mountingMode, CalibrationBoardModel boardModel) |
Sets the board model and camera mounting mode for this calibration. | |
ErrorStatus | addPoseAndDetect (Camera &camera, const Transformation &poseData, Color2DImage &color2DImage, unsigned int timeoutMs=10000) |
Adds current pose of the robot, captures the image, and calculates necessary parameters prepared for calibration. | |
ErrorStatus | calculateExtrinsics (Camera &camera, Transformation &cameraToBase) |
Starts to calculate the result of hand-eye calibration. | |
ErrorStatus | testRecognition (Camera &camera, Color2DImage &testResult, unsigned int timeoutMs=10000) |
Only captures current image with feature recognition result for test. | |
Definition at line 10 of file HandEyeCalibration.h.
Only takes effect in process of hand-eye calibration. Option for board model.
Definition at line 25 of file HandEyeCalibration.h.
Only takes effect in process of hand-eye calibration. Option for camera mounting mode.
Enumerator | |
---|---|
EyeInHand | The camera is mounted in the robot's hand. |
EyeToHand | The camera is fixed mountedwith respect to the robot's base. |
Definition at line 17 of file HandEyeCalibration.h.
ErrorStatus mmind::eye::HandEyeCalibration::addPoseAndDetect | ( | Camera & | camera, |
const Transformation & | poseData, | ||
Color2DImage & | color2DImage, | ||
unsigned int | timeoutMs = 10000 ) |
Adds current pose of the robot, captures the image, and calculates necessary parameters prepared for calibration.
[in] | camera | The camera handle. |
[in] | poseData | The current pose of the robot. See Transformation for details. |
[out] | color2DImage | The current 2D image with feature recognition result. See Color2DImage for details. |
[in] | timeoutMs | The timeout for connecting a camera in ms unit. If the execution time of the connecting process is greater than the timeout, the function will immediately return ErrorStatus::MMIND_STATUS_TIMEOUT_ERROR. |
ErrorStatus mmind::eye::HandEyeCalibration::calculateExtrinsics | ( | Camera & | camera, |
Transformation & | cameraToBase ) |
Starts to calculate the result of hand-eye calibration.
[in] | camera | The camera handle. |
[out] | cameraToBase | The result of hand-eye calibration. See Transformation. |
ErrorStatus mmind::eye::HandEyeCalibration::initializeCalibration | ( | Camera & | camera, |
CameraMountingMode | mountingMode, | ||
CalibrationBoardModel | boardModel ) |
Sets the board model and camera mounting mode for this calibration.
[in] | camera | The camera handle. |
[in] | mountingMode | The camera mounting mode. See CameraMountingMode for details. |
[in] | boardModel | The calibration board model. See CalibrationBoardModel for details. |
ErrorStatus mmind::eye::HandEyeCalibration::testRecognition | ( | Camera & | camera, |
Color2DImage & | testResult, | ||
unsigned int | timeoutMs = 10000 ) |
Only captures current image with feature recognition result for test.
[in] | camera | The camera handle. |
[out] | testResult | The current 2D image with feature recognition resul. See Color2DImage for details. |
[in] | timeoutMs | The timeout for connecting a camera in ms unit. If the execution time of the connecting process is greater than the timeout, the function will immediately return ErrorStatus::MMIND_STATUS_TIMEOUT_ERROR. |