CalibrationResult Class Reference

Inheritance diagram for CalibrationResult:

Data Structures
class	Handle

Public Member Functions
	CalibrationResult (string filePath)
	Constructs a CalibrationResult instance by loading data from a JSON file.
void	Dispose ()
	Releases the resources used by the CalibrationResult class.

Static Public Member Functions
static implicit	operator CalibrationParameters (CalibrationResult calibrationResult)
	Implicitly converts a CalibrationResult into calibration parameters.

Properties
CalibrationParameters	CalibrationParameters [get]
	Extracts the calibration parameters from a calibration result.
double	MeanReprojectionError [get]
	Retrieves the mean reprojection error from the calibration result.
DisposableList< CalibrationView >	Views [get]
	Returns a vector of CalibrationView objects.

Detailed Description

Holds the results of a camera calibration.

The CalibrationResult class stores the intrinsic and extrinsic parameters, the mean reprojection error, and a collection of calibration views, each representing marker positions and corresponding reprojection errors in the image.

These results are typically produced by the CameraCalibration.Process() method.

Since

IDSImaging.Peak.ICV 1.3

Constructor & Destructor Documentation

CalibrationResult()

CalibrationResult ( string filePath )

inline

Constructs a CalibrationResult instance by loading data from a JSON file.

This constructor initializes the calibration result by parsing the given file, which contains intrinsic parameters, the mean reprojection error, and the calibration views.

Parameters

filePath

An existing file path to a calibration result JSON file.

Exceptions

IcvIOException	The specified file path is invalid or lacks read permissions.
IcvCorruptedException	The file cannot be read.

Since

IDSImaging.Peak.ICV 1.3

Member Function Documentation

Dispose()

void Dispose ( )

inline

Releases the resources used by the CalibrationResult class.

Since

IDSImaging.Peak.ICV 1.3

operator CalibrationParameters()

static implicit operator CalibrationParameters ( CalibrationResult calibrationResult )

inlinestatic

Implicitly converts a CalibrationResult into calibration parameters.

This operator calls CalibrationResult.CalibrationParameters to extract the calibration parameters.

Parameters

calibrationResult

Calibration result to be converted to calibration parameters.

Since

IDSImaging.Peak.ICV 1.3

Property Documentation

CalibrationParameters

CalibrationParameters CalibrationParameters

get

Extracts the calibration parameters from a calibration result.

This function extracts the calibration parameters required for image operations such as point cloud generation, image undistortion, and other calibration-dependent tasks. The extracted parameters include intrinsic parameters and, depending on the number of calibration views, extrinsic parameters.

• Intrinsic parameters are always extracted from the calibration result.
• If the calibration result contains exactly one calibration view, the extrinsic parameters are taken from that view.
• If multiple calibration views are present (e.g., from a full camera calibration), the extrinsic parameters are set to the identity matrix.

To use extrinsic parameters from a specific calibration view rather than the identity matrix, retrieve the desired view using CalibrationResult::GetViews() and incorporate its parameters accordingly.

Since

IDSImaging.Peak.ICV 1.3

MeanReprojectionError

double MeanReprojectionError

get

Retrieves the mean reprojection error from the calibration result.

The mean reprojection error is the root mean square of distances between the marker points detected from the calibration images and the projected world points, measured in pixels.

Since

IDSImaging.Peak.ICV 1.3

Views

DisposableList<CalibrationView> Views

get

Returns a vector of CalibrationView objects.

The order of the returned CalibrationViews corresponds exactly to the order of images passed to CameraCalibration.Process().

Since

IDSImaging.Peak.ICV 1.3