CalibrateWorldPlane_OffgridOrigin


Finds the image to world plane transformation matrix, with world origin and axes specified in the image coordinates.

Applications:Rather rarely seen special cases where absolute world plane coordinates cannot be specified in terms of calibration grid, but the location of world plane origin is still required. When in doubt, use the CalibrateWorldPlane_Labeled filter.

Syntax

C++
C#
Python
 
def CalibrateWorldPlane_OffgridOrigin(
	inImageGrid: list[AnnotatedPoint2D],
	outTransform: RectificationTransform,
	/,
	*,
	inCameraModel: AnyCameraModel | None = None,
	inGridSpacing: float = 1.0,
	inGridThickness: float = 0.0,
	inWorldPlaneOrigin: Point2D | None = None,
	inWorldPlaneXAxis: Point2D | None = None
)
-> (
	outRmsError: float,
	outMaxReprojectionError: float,
	outReprojectionErrorSegments: list[Segment2D]
)

Parameters

Name Type Range Default Description
Input value inImageGrid list[AnnotatedPoint2D] Annotated calibration grid
Input value inCameraModel AnyCameraModel | None None For undistortion of inImageGrid. If not supplied, the filter will assume that grid came from undistorted image.
Input value inGridSpacing float 0.000001 - 1.0 Real-world distance between adjacent grid points.
Input value inGridThickness float 0.0 The world plane will be shifted by given amount in direction perpendicular to the grid to compensate for grid thickness. Note, that inWorldPlaneOrigin and inWorldPlaneXAxis won't be compensated, so they need to be selected on the target world plane, and not on the grid.
Input value inWorldPlaneOrigin Point2D | None None Sets world plane origin (as the image point). The world plane origin will lie at the specified image point. Note, that this point won't be shifted by inGridThickness parameter.
Input value inWorldPlaneXAxis Point2D | None None Sets world plane x axis direction (as the image point). The world plane x axis will lie at the specified image point. Note, that this point won't be shifted by inGridThickness parameter.
Output value outTransform RectificationTransform
Output value outRmsError float RMS reprojection error, in pixels.
Output value outMaxReprojectionError float Maximum reprojection error, in pixels.
Output value outReprojectionErrorSegments list[Segment2D] Array of segments connecting input image points to grid reprojections.