CalibrationResult Class Reference

Public Member Functions
CalibrationResult	create_from_file (cls, str file_path)
	Creates an instance of CalibrationResult by loading the calibration result from a file.
None	__init__ (self, *Any args, **Any kwargs)
	In order to create a CalibrationResult, please refer to the classmethods.
None	__del__ (self)
float	mean_reprojection_error (self)
	Provides the mean reprojection error from calibration result.
CalibrationViewArray	views (self)
	Provides a list of CalibrationView.
None	save (self, str file_path)
	Saves calibration result to a JSON file for later use.
CalibrationParameters	calibration_parameters (self)
	Provides the CalibrationParameters that contain the necessary information to use the camera calibration.

Protected Member Functions
CalibrationResult	_create_empty (cls)

Protected Attributes
	_handle
np.ndarray|None	_views = None

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().

Since

ids_peak_icv 1.1

Constructor & Destructor Documentation

__init__()

None __init__	(		self,
		*Any	args,
		**Any	kwargs )

In order to create a CalibrationResult, please refer to the classmethods.

Since

ids_peak_icv 1.1

__del__()

None __del__

(

self

)

Member Function Documentation

_create_empty()

CalibrationResult _create_empty ( cls )

protected

calibration_parameters()

CalibrationParameters calibration_parameters

(

self

)

Provides the CalibrationParameters that contain the necessary information to use the camera calibration.

Returns

An instance of CalibrationParameters

Since

ids_peak_icv 1.1

create_from_file()

CalibrationResult create_from_file	(		cls,
		str	file_path )

Creates an instance of CalibrationResult by loading the calibration result from a file.

Parameters

file_path

An existing file path to a JSON file containing the calibration result.

Returns

A new instance of CalibrationResult

Exceptions

IOException	If the given file_path does not exist, or the permissions are not sufficient to read it.
CorruptedException	If the file content is corrupted.

Since

ids_peak_icv 1.1

mean_reprojection_error()

float mean_reprojection_error

(

self

)

Provides 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 from the used calibration plate.

Since

ids_peak_icv 1.1

save()

None save	(		self,
		str	file_path )

Saves calibration result to a JSON file for later use.

Parameters

file_path

An existing file path to save calibration result.

Exceptions

IOException

If the specified file path is invalid, you lack the necessary permissions, or the file already exists.

Since

ids_peak_icv 1.1

views()

CalibrationViewArray views

(

self

)

Provides a list of CalibrationView.

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

Since

ids_peak_icv 1.1

Field Documentation

_handle

_handle

protected

Initial value:

=  check_init_for_classes_with_classmethods_only(self.__class__.__name__,
                                                                     peak_icv_calibration_result_handle,
                                                                     *args, **kwargs)

_views

np.ndarray | None _views = None

protected