ImFusion C++ SDK 4.4.0
ImFusion::MarkerHandEyeCalibrationAlgorithm Class Reference

#include <ImFusion/Vision/MarkerHandEyeCalibrationAlgorithm.h>

Performs hand eye calibration of a sensor that provides tracking information (called "tracker") to a camera that captured images of a marker board (called "camera"). More...

Inheritance diagram for ImFusion::MarkerHandEyeCalibrationAlgorithm:

Detailed Description

Performs hand eye calibration of a sensor that provides tracking information (called "tracker") to a camera that captured images of a marker board (called "camera").

The tracking information associated with each frame in the TrackedSharedImageSet is assumed to be correct, no further tracking sequence alignment is performed

Public Member Functions

 MarkerHandEyeCalibrationAlgorithm (TrackedSharedImageSet *tis)
 Construct from a TrackedSharedImageSet combining the camera images and the tracking information.
 MarkerHandEyeCalibrationAlgorithm (SharedImageSet *is, TrackingSequence *ts)
 Construct from image and tracking information.
void setMarkerConfig (const MarkerConfiguration &config)
 Set marker configuration.
MarkerConfigurationmarkerConfig ()
void setMarkerMaxReprojError (double v)
 Set the maximum reprojection error in pixels for marker detection.
double markerMaxReprojError () const
void setMarkerMinDetections (int v)
 Set the minimum number of points to detect per marker.
double markerMinDetections () const
void setPoseInlierThreshold (double v)
 Set maximum distance in terms of combined distance and euler angle norm for pose-pairs to use in hand-eye calibration.
double poseInlierThreshold () const
void setMinRelativeAngle (double v)
 Set minimum relative angle for pose-pairs to use in hand-eye calibration.
double minRelativeAngle () const
void setRefineNonLinear (bool v)
 Set whether to refine the initial hand-eye calibration.
bool refineNonLinear () const
void setRefineMRE (bool v)
 Refine MRE instead of pose error.
bool refineMRE () const
void setUseRANSAC (bool v)
 Set whether to use the RANSAC version of hand-eye calibration.
bool useRANSAC () const
void setApplyHandEyeCalibToInput (bool v)
 Set whether to apply the computed hand-eye calibration to the input tracked shared image set.
bool applyHandEyeCalibToInput ()
void setRefineTimeOffset (bool v)
 Refine the timeoffset (only done if refineMRE is also true).
bool refineTimeOffset ()
void compute () override
 Run calibration.
std::vector< std::vector< vec2 > > detectedPointsCamera () const
 Returns the 2D image positions of the detected calibration target points for each frame. The projection is done using the estimated camera pose.
double reprojectedPointsCamera (std::vector< std::vector< vec2 > > *reprojectedPoints=nullptr) const
 Returns the 2D image positions of the reprojected calibration target points for each frame and an MRE. The projection is done using the estimated camera pose.
double reprojectedPointsHandEye (std::vector< std::vector< vec2 > > *reprojectedPoints=nullptr) const
 Returns the 2D image positions of the reprojected calibration target points for each frame and an MRE. The projection is done using the computed hand-eye calibration and registration.
double reprojectedPointsHandEye (const mat4 &camToTrackerTarget, const mat4 &calibToTracker, double timeOffset, double scale=1.0, std::vector< std::vector< vec2 > > *reprojectedPoints=nullptr) const
 Returns the 2D image positions of the reprojected calibration target points for each frame and an MRE. The projection is done using the provided hand-eye calibration, registration and time offset.
std::pair< double, double > meanHandEyePoseError (const mat4 &camToTrackerTarget, const mat4 &calibToTracker, double timeOffset, double scale) const
 Returns average angle error in degrees and average translation error given the provided hand-eye calibration, registration and time offset.
const TrackingSequencetsCamera (bool used) const
 Get camera tracking sequence. When used is set to true, the stream will only contain the samples which are used in the hand-eye calibration, and it will be updated using a marker scale factor (if any).
const TrackingSequencetsTracker (bool used) const
 Get tracker tracking sequence. When used is set to true, the stream will only contain the samples which are used in the hand-eye calibration.
TrackedSharedImageSetimages () const
 Return internally used tracked shared image set.
SharedImageSetinputImages () const
 Return input images. Returns nullptr if the algorithm was constructed with a TrackedSharedImageSet.
mat4 camToTrackerTarget () const
 Get hand-eye calibration matrix (camera to camera tracker target).
mat4 calibToTracker () const
 Get registration matrix (calibration target to tracker).
double timeOffset () const
 Get the time offset used for the hand-eye calibration.
double scale () const
 Get the marker scale factor.
OwningDataList takeOutput () override
 Return any new Data that was created by the Algorithm during the last call to compute().
void configure (const Properties *p) override
 Configure this object instance by de-serializing the given Properties.
void configuration (Properties *p) const override
 Serialize the current object configuration into the given Properties object.
Public Member Functions inherited from ImFusion::Algorithm
 Algorithm ()
 Default constructor will registers a single "compute" action that calls compute() and returns status().
virtual void setProgress (Progress *progress)
 Sets a Progress interface the algorithm can use to notify observers about its computing progress.
Progressprogress () const
 Returns the progress interface if set.
virtual int status () const
 Indicates the status of the last call to compute().
virtual bool survivesDataDeletion (const Data *) const
 Indicates whether the algorithm can handle (partial) deletion of the specified data, by default this checks whether the data is in the input list.
const FactoryInfofactoryInfo () const
 Returns the record describing how this Algorithm was instantiated by the AlgorithmFactory.
void setFactoryInfo (const FactoryInfo &value)
 Sets the record describing how this Algorithm was instantiated by the AlgorithmFactory.
Status runAction (const std::string &id)
 Run the action with name id if it exists.
const std::vector< Action > & actions ()
 Get a mapping from Action id to Action as registered in this algorithm.
Public Member Functions inherited from ImFusion::Configurable
virtual void configureDefaults ()
 Retrieve the properties of this object, replaces values with their defaults and sets it again.
void registerParameter (ParameterBase *param)
 Register the given Parameter or SubProperty, so that it will be configured during configure()/configuration().
void unregisterParameter (const ParameterBase *param)
 Remove the given Parameter or SubProperty from the list of registered parameters.
 Configurable (const Configurable &rhs)
 Configurable (Configurable &&rhs) noexcept
Configurable & operator= (const Configurable &)
Configurable & operator= (Configurable &&) noexcept

Static Public Member Functions

static bool createCompatible (const DataList &data, Algorithm **a=nullptr)
Static Public Member Functions inherited from ImFusion::Algorithm
static bool createCompatible (const DataList &data, Algorithm **a=nullptr)
 Factory function to check algorithm compatibility with input data and optionally instantiate it.

Public Attributes

Parameter< HandEyeCalibrationAlgorithm::CalibrationTypep_calibrationType
 Calibration type, either EyeInHand or EyeOnBase.
Parameter< HandEyeCalibrationAlgorithm::StreamInfop_streamInfoTracker
 Direction of the transformation of the tracking sequence.
Parameter< bool > p_matchTimestamps
 Match camera and tracker frames by timestamps, otherwise match by frame index.
Parameter< bool > p_optimizeScale = {"optimizeScale", false, this}
 Optimize a scale factor for the marker board size.
Public Attributes inherited from ImFusion::Algorithm
Signal signalOutputChanged
 Signal should be emitted by Algorithms when their output/result has changed.
Signal signalParametersChanged
 Signal should be emitted by Algorithms when their parameter configuration has changed.
Public Attributes inherited from ImFusion::Configurable
Signal signalParametersChanged
 Emitted whenever one of the registered Parameters' or SubPropertys' signalValueChanged signal was emitted.

Additional Inherited Members

Public Types inherited from ImFusion::Algorithm
enum  Status {
  Unknown = -1 , Success = 0 , Error = 1 , InvalidInput ,
  IncompleteInput , OutOfMemoryHost , OutOfMemoryGPU , UnsupportedGPU ,
  UnknownAction , AbortedByUser , User = 1000
}
 Status codes. More...
Protected Member Functions inherited from ImFusion::Algorithm
void loadDefaults ()
void registerAction (const std::string &id, const std::string &guiName, const std::function< Algorithm::Status(void)> &action)
 Register an action to be run via runAction.
template<typename D>
void registerAction (const std::string &id, const std::string &guiName, Algorithm::Status(D::*action)(void))
 Template version of runAction that can be used with a pointer to a member function.
void registerAction (const Action &action)
 Register an action.
Protected Attributes inherited from ImFusion::Algorithm
std::string m_name
 Algorithm name.
Progressm_progress = nullptr
 Non-owing pointer to a progress interface. May be a nullptr.
FactoryInfo m_factoryInfo = {}
 Record describing how this algorithm was instantiated by the AlgorithmFactory.
int m_status = Status::Unknown
 Algorithm status after last call to compute().
std::vector< Actionm_actions
 Map of key given by the id of the action, of the available actions of this algorithm.
Protected Attributes inherited from ImFusion::Configurable
std::vector< Paramm_params
 List of all registered Parameter and SubProperty instances.

Member Function Documentation

◆ compute()

void ImFusion::MarkerHandEyeCalibrationAlgorithm::compute ( )
overridevirtual

Run calibration.

Implements ImFusion::Algorithm.

◆ takeOutput()

OwningDataList ImFusion::MarkerHandEyeCalibrationAlgorithm::takeOutput ( )
overridevirtual

Return any new Data that was created by the Algorithm during the last call to compute().

The default implementation will return an empty list.

Note
Since ownership of the data is transferred, you can call this method only once between calls to compute().

Reimplemented from ImFusion::Algorithm.

◆ configure()

void ImFusion::MarkerHandEyeCalibrationAlgorithm::configure ( const Properties * p)
overridevirtual

Configure this object instance by de-serializing the given Properties.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also
configuration() for the inverse functionality

Reimplemented from ImFusion::Configurable.

◆ configuration()

void ImFusion::MarkerHandEyeCalibrationAlgorithm::configuration ( Properties * p) const
overridevirtual

Serialize the current object configuration into the given Properties object.

The default implementation will do so automatically for all registered Parameter and SubProperty instances.

See also
configure() for the inverse functionality

Reimplemented from ImFusion::Configurable.

Member Data Documentation

◆ p_calibrationType

Parameter<HandEyeCalibrationAlgorithm::CalibrationType> ImFusion::MarkerHandEyeCalibrationAlgorithm::p_calibrationType
Initial value:
= {"calibrationType",
this}
@ EyeInHand
The camera is mounted on the robot end effector (moving object is the camera, fixed object is the cal...
Definition HandEyeCalibrationAlgorithm.h:63

Calibration type, either EyeInHand or EyeOnBase.

◆ p_streamInfoTracker

Parameter<HandEyeCalibrationAlgorithm::StreamInfo> ImFusion::MarkerHandEyeCalibrationAlgorithm::p_streamInfoTracker
Initial value:
= {
"streamInfoTracker",
HandEyeCalibrationAlgorithm::HandToBase,
this}

Direction of the transformation of the tracking sequence.

◆ p_matchTimestamps

Parameter<bool> ImFusion::MarkerHandEyeCalibrationAlgorithm::p_matchTimestamps
Initial value:
= {"matchTimestamps",
true,
this}

Match camera and tracker frames by timestamps, otherwise match by frame index.


The documentation for this class was generated from the following file:
  • ImFusion/Vision/MarkerHandEyeCalibrationAlgorithm.h
Search Tab / S to search, Esc to close