IDS peak ICV v1.1.0
Loading...
Searching...
No Matches
CalibrationView Class Reference

Public Member Functions

None __init__ (self, *Any args, **Any kwargs)
 Please do not use this function.
 
None __del__ (self)
 
float mean_reprojection_error (self)
 Provides the mean reprojection error from a calibration view.
 
float maximum_reprojection_error (self)
 Provides the maximum reprojection error from a calibration view.
 
ReprojectionErrorArray reprojection_errors (self)
 Provides the reprojection errors for every marker in the view.
 
ExtrinsicParameters extrinsic_parameters (self)
 Provides the extrinsic parameters for the view.
 
Polygon convex_hull (self)
 Provides the convex hull of the found calibration pattern in the view.
 
CoordinateSystem coordinate_system (self)
 Provides the coordinate system of the calibration view that was projected into the image plane.
 

Protected Member Functions

CalibrationView _create_empty (cls)
 

Protected Attributes

 _handle = kwargs["_handle"]
 
np.ndarray|None _errors = None
 

Detailed Description

Class for holding the extrinsic result for one image of a camera calibration and also the reprojection errors of every detected marker.

Since
ids_peak_icv 1.1

Definition at line 24 of file calibration_view.py.

Constructor & Destructor Documentation

◆ __init__()

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

Please do not use this function.

Refer to CalibrationResult.views to get views from a calibration result.

Since
ids_peak_icv 1.1

Definition at line 42 of file calibration_view.py.

◆ __del__()

None __del__ ( self)

Definition at line 55 of file calibration_view.py.

Member Function Documentation

◆ _create_empty()

CalibrationView _create_empty ( cls)
protected

Definition at line 35 of file calibration_view.py.

◆ convex_hull()

Polygon convex_hull ( self)

Provides the convex hull of the found calibration pattern in the view.

Returns
Returns the convex hull as polygon from a calibration view.
Since
ids_peak_icv 1.1

Definition at line 156 of file calibration_view.py.

◆ coordinate_system()

CoordinateSystem coordinate_system ( self)

Provides the coordinate system of the calibration view that was projected into the image plane.

The coordinate system is represented by its origin and three vectors, each corresponding to one of the three coordinate axes (X, Y and Z). These vectors describe the directions of the respective axes projected from 3D into 2D space. Their lengths are determined by twice the distance between neighboring markers on the calibration plate.

Returns
Returns the coordinate system from a calibration view.
Since
ids_peak_icv 1.1

Definition at line 173 of file calibration_view.py.

◆ extrinsic_parameters()

ExtrinsicParameters extrinsic_parameters ( self)

Provides the extrinsic parameters for the view.

A view always contains extrinsic parameters that describe the transformation from the calibration plate coordinate system into the camera coordinate system.

Returns
Returns the extrinsic parameters from a calibration view.
Since
ids_peak_icv 1.1

Definition at line 135 of file calibration_view.py.

◆ maximum_reprojection_error()

float maximum_reprojection_error ( self)

Provides the maximum reprojection error from a calibration view.

The reprojection error is the distance between the marker points extracted from the calibration images and the projected world points from CalibrationPlateInfo.

Returns
Returns the maximum reprojection error.
Since
ids_peak_icv 1.1

Definition at line 79 of file calibration_view.py.

◆ mean_reprojection_error()

float mean_reprojection_error ( self)

Provides the mean reprojection error from a calibration view.

The reprojection error is the distance between the marker points extracted from the calibration images and the projected world points from CalibrationPlateInfo.

Returns
Returns the mean reprojection error.
Since
ids_peak_icv 1.1

Definition at line 60 of file calibration_view.py.

◆ reprojection_errors()

ReprojectionErrorArray reprojection_errors ( self)

Provides the reprojection errors for every marker in the view.

The reprojection error is the distance between the marker points extracted from the calibration images and the projected world points from CalibrationPlateInfo.

Returns
Returns all reprojection errors.
Since
ids_peak_icv 1.1

Definition at line 98 of file calibration_view.py.

Field Documentation

◆ _errors

_errors = None
protected

Definition at line 53 of file calibration_view.py.

◆ _handle

_handle = kwargs["_handle"]
protected

Definition at line 50 of file calibration_view.py.