CalibrationResult Class Reference

#include <peak_icv/algorithms/calibration/peak_icv_calibration_result.hpp>

Inheritance diagram for CalibrationResult:

Collaboration diagram for CalibrationResult:

Public Member Functions
	CalibrationResult (const std::string &filePath)
	Creates an instance of class CalibrationResult by loading it from file.
	~CalibrationResult () override
	CalibrationResult (const CalibrationResult &other)
	CalibrationResult (CalibrationResult &&other) noexcept
CalibrationResult &	operator= (const CalibrationResult &other)
CalibrationResult &	operator= (CalibrationResult &&other) noexcept
double	GetMeanReprojectionError () const
	Retrieves the mean reprojection error from calibration result.
std::vector< CalibrationView >	GetViews () const
	Provides a vector of CalibrationView.
CalibrationParameters	GetCalibrationParameters () const
	Extract the calibration parameters from a calibration result. The calibration parameters contain only the necessary information to use the camera calibration.
	operator CalibrationParameters () const
	Implicitly converts a calibration result into calibration parameters by extracting the calibration parameters from it. The calibration parameters contain only the necessary information to use the camera calibration.

Detailed Description

Class for holding the results of a camera calibration.

The CalibrationResult stores intrinsic and extrinsic parameters as well as the mean reprojection error calculated by CameraCalibration.Process().

Warning

This function is still in development and not released.

Definition at line 37 of file peak_icv_calibration_result.hpp.

Constructor & Destructor Documentation

CalibrationResult() [1/3]

CalibrationResult ( const std::string & filePath )

inlineexplicit

Creates an instance of class CalibrationResult by loading it from file.

Parameters

[in]

filePath

An existing file path to a calibration result JSON file.

Exceptions

IOException	If the given file_path does not exist, or the permissions are not sufficient to read it.
CorruptedException	If the file cannot be read.

Warning

This function is still in development and not released.

Definition at line 234 of file peak_icv_calibration_result.hpp.

~CalibrationResult()

~CalibrationResult ( )

inlineoverride

Warning

This function is still in development and not released.

Definition at line 226 of file peak_icv_calibration_result.hpp.

CalibrationResult() [2/3]

CalibrationResult ( const CalibrationResult & other )

inline

Warning

This function is still in development and not released.

Definition at line 174 of file peak_icv_calibration_result.hpp.

CalibrationResult() [3/3]

CalibrationResult ( CalibrationResult && other )

inlinenoexcept

Warning

This function is still in development and not released.

Definition at line 182 of file peak_icv_calibration_result.hpp.

Member Function Documentation

GetCalibrationParameters()

CalibrationParameters GetCalibrationParameters ( ) const

inline

Extract the calibration parameters from a calibration result. The calibration parameters contain only the necessary information to use the camera calibration.

This function extracts the calibration parameters of the camera calibration. These parameters are essential for image operations like point cloud generation, image undistortion, and other calibration-dependent operations. Calibration parameters contain only intrinsic parameters and extrinsic parameters. The intrinsic parameters are always extracted from the calibration result. If the calibration result contains a single calibration view the extrinsic parameters are extracted from this view. If there are multiple calibration views e.g. as a result of a camera calibration, the extrinsic parameters are set to the identity matrix. In case you do not want to use the identity matrix but a specific calibration view from the calibration result as source for the extrinsic parameters the parameters of the view can be extracted using CalibrationResult::GetViews(), and integrated again via the struct.

Warning

This function is still in development and not released.

Definition at line 272 of file peak_icv_calibration_result.hpp.

GetMeanReprojectionError()

double GetMeanReprojectionError ( ) const

inline

Retrieves the mean reprojection error from calibration result.

The mean reprojection error is the root mean square of distances between the marker points extracted from the calibration images and the projected world points.

Warning

This function is still in development and not released.

Definition at line 241 of file peak_icv_calibration_result.hpp.

GetViews()

std::vector< CalibrationView > GetViews ( ) const

inline

Provides a vector of CalibrationView.

The order in which the CalibrationViews are provided, is equivalent to the order of images provided to peak::icv::experimental::CameraCalibration::Process.

Warning

This function is still in development and not released.

Definition at line 252 of file peak_icv_calibration_result.hpp.

operator CalibrationParameters()

operator CalibrationParameters ( ) const

inline

Implicitly converts a calibration result into calibration parameters by extracting the calibration parameters from it. The calibration parameters contain only the necessary information to use the camera calibration.

This function extracts the calibration parameters of the camera calibration. These parameters are essential for image operations like point cloud generation, image undistortion, and other calibration-dependent operations. Calibration parameters contain only intrinsic parameters and extrinsic parameters. The intrinsic parameters are always extracted from the calibration result. If the calibration result contains a single calibration view the extrinsic parameters are extracted from this view. If there are multiple calibrations views e.g. as a result of a camera calibration, the extrinsic parameters are set to the identity matrix.

Warning

This function is still in development and not released.

Definition at line 283 of file peak_icv_calibration_result.hpp.

operator=() [1/2]

CalibrationResult & operator= ( CalibrationResult && other )

inlinenoexcept

Warning

This function is still in development and not released.

Definition at line 208 of file peak_icv_calibration_result.hpp.

operator=() [2/2]

CalibrationResult & operator= ( const CalibrationResult & other )

inline

Warning

This function is still in development and not released.

Definition at line 188 of file peak_icv_calibration_result.hpp.