Mech-Eye API 2.4.0
API reference documentation for Mech-Eye Industrial 3D Camera
Loading...
Searching...
No Matches
Classes | Public Types | Public Member Functions | List of all members
mmind::eye::HandEyeCalibration Class Reference

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.
 

Detailed Description

Definition at line 10 of file HandEyeCalibration.h.

Member Enumeration Documentation

◆ CalibrationBoardModel

Only takes effect in process of hand-eye calibration. Option for board model.

Definition at line 25 of file HandEyeCalibration.h.

◆ CameraMountingMode

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.

Member Function Documentation

◆ addPoseAndDetect()

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.

Parameters
[in]cameraThe camera handle.
[in]poseDataThe current pose of the robot. See Transformation for details.
[out]color2DImageThe current 2D image with feature recognition result. See Color2DImage for details.
[in]timeoutMsThe 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.
Returns
See ErrorStatus for details.

◆ calculateExtrinsics()

ErrorStatus mmind::eye::HandEyeCalibration::calculateExtrinsics ( Camera & camera,
Transformation & cameraToBase )

Starts to calculate the result of hand-eye calibration.

Parameters
[in]cameraThe camera handle.
[out]cameraToBaseThe result of hand-eye calibration. See Transformation.
Returns
See ErrorStatus for details.

◆ initializeCalibration()

ErrorStatus mmind::eye::HandEyeCalibration::initializeCalibration ( Camera & camera,
CameraMountingMode mountingMode,
CalibrationBoardModel boardModel )

Sets the board model and camera mounting mode for this calibration.

Parameters
[in]cameraThe camera handle.
[in]mountingModeThe camera mounting mode. See CameraMountingMode for details.
[in]boardModelThe calibration board model. See CalibrationBoardModel for details.
Returns
See ErrorStatus for details.

◆ testRecognition()

ErrorStatus mmind::eye::HandEyeCalibration::testRecognition ( Camera & camera,
Color2DImage & testResult,
unsigned int timeoutMs = 10000 )

Only captures current image with feature recognition result for test.

Parameters
[in]cameraThe camera handle.
[out]testResultThe current 2D image with feature recognition resul. See Color2DImage for details.
[in]timeoutMsThe 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.
Returns
See ErrorStatus for details.

The documentation for this class was generated from the following file: