WorkspaceCalibration Class Reference

Public Member Functions
WorkspaceCalibration	create_from_intrinsics_and_plate (cls, IntrinsicParameters intrinsic_parameters, CalibrationPlate calibration_plate)
	Creates an instance of class WorkspaceCalibration.
None	__init__ (self, *Any args, **Any kwargs)
	In order to create a WorkspaceCalibration, please refer to the classmethods.
CalibrationResult	process (self, Union[Image, ids_peak_ipl.Image] image)
	Applies the workspace calibration and calculates the extrinsic camera parameters based on a single view of a calibration pattern.

Protected Attributes
	_intrinsic_parameters = kwargs["_intrinsic_parameters"]
	_calibration_plate = kwargs["_calibration_plate"]

Detailed Description

Class for calibrating a workspace.

The WorkspaceCalibration calculates the extrinsic parameters based on a single image.

Since

ids_peak_icv 1.1

Constructor & Destructor Documentation

__init__()

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

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

Since

ids_peak_icv 1.1

Member Function Documentation

create_from_intrinsics_and_plate()

WorkspaceCalibration create_from_intrinsics_and_plate	(		cls,
		IntrinsicParameters	intrinsic_parameters,
		CalibrationPlate	calibration_plate )

Creates an instance of class WorkspaceCalibration.

In order to perform a workspace calibration, intrinsic parameters and a calibration plate must be provided.

Parameters

intrinsic_parameters	Can be obtained using e.g. CameraCalibration.process() or CalibrationParameters.create_from_file().
calibration_plate	A calibration plate.

Since

ids_peak_icv 1.1

process()

CalibrationResult process	(		self,
		Union[Image, ids_peak_ipl.Image]	image )

Applies the workspace calibration and calculates the extrinsic camera parameters based on a single view of a calibration pattern.

Furthermore, it computes the mean reprojection error.

Note

This operation disregards any specified image regions. It processes the entire image.

Parameters

image

An image containing a single calibration plate.

Exceptions

NotPossibleException	If no image is provided.
NotSupportedException	If the image format is not supported.
MismatchException	If the sizes of the image is different to the one given in the intrinsic parameters.
TargetNotFoundException	If the images does not contain any calibration plate.

Since

ids_peak_icv 1.1

Field Documentation

_calibration_plate

_calibration_plate = kwargs["_calibration_plate"]

protected

_intrinsic_parameters

_intrinsic_parameters = kwargs["_intrinsic_parameters"]

protected