Zivid C++ API 2.13.1+18e79e79-1
Zivid::Calibration::DetectionResult Class Reference

A result returned by the detectCalibrationBoard(...) call. More...

#include <Zivid/Calibration/DetectionResult.h>

Public Member Functions

ZIVID_CORE_EXPORT bool valid () const
 Test if DetectionResult is valid.
 
ZIVID_CORE_EXPORT operator bool () const
 Test if DetectionResult is valid.
 
ZIVID_CORE_EXPORT PointXYZ centroid () const
 Get the centroid of the detected feature points in camera-space.
 
ZIVID_CORE_EXPORT Pose pose () const
 Get position and orientation of the top left detected corner in camera coordinate system.
 
ZIVID_CORE_EXPORT std::string toString () const
 Get string representation of DetectionResult.
 

Detailed Description

A result returned by the detectCalibrationBoard(...) call.

Member Function Documentation

◆ centroid()

ZIVID_CORE_EXPORT PointXYZ Zivid::Calibration::DetectionResult::centroid ( ) const

Get the centroid of the detected feature points in camera-space.

If valid() is false, an exception will be thrown.

Returns
The XYZ position of the feature point centroid.

◆ operator bool()

ZIVID_CORE_EXPORT Zivid::Calibration::DetectionResult::operator bool ( ) const
explicit

Test if DetectionResult is valid.

DetectionResult is valid if all the feature points were detected.

Returns
True if DetectionResult is valid.

◆ pose()

ZIVID_CORE_EXPORT Pose Zivid::Calibration::DetectionResult::pose ( ) const

Get position and orientation of the top left detected corner in camera coordinate system.

This is the top left inner corner as viewed from the board's coordinate system. For example, if the board is rotated 180 degrees, this will be the bottom right corner.

Pose calculation works for official Zivid calibration boards only. An exception will be thrown if valid() is false or if the board is not supported.

Returns
The XYZ position and orientation of the top left corner.

◆ toString()

ZIVID_CORE_EXPORT std::string Zivid::Calibration::DetectionResult::toString ( ) const

Get string representation of DetectionResult.

Returns
DetectionResult as string

◆ valid()

ZIVID_CORE_EXPORT bool Zivid::Calibration::DetectionResult::valid ( ) const

Test if DetectionResult is valid.

DetectionResult is valid if all the feature points were detected.

Returns
True if DetectionResult is valid.

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