ILCalibCustom Interface Reference

This interface provide functionalities of the custom camera model. More...

Inheritance diagram for ILCalibCustom:

Public Member Functions
void	MoveOriginTo (double x, double y)
Public Member Functions inherited from ILCalib
LPVErrorCode	AddPoint (double imagePointX, double imagePointY, double worldPointX, double worldPointY)
LPVErrorCode	AddPoints (ILCalibPointPairs *pointPairs)
LPVErrorCode	Calibrate ()
LPVErrorCode	FixImage (ILImage *image, ILImage *fixedImage)
LPVErrorCode	GenPostTransformMatrix (ILCalibPointPairs *pointPairs)
void	ImageToWorld (double imagePointX, double imagePointY, double *worldPointX, double *worldPointY)
BOOL	IsCalibrated ()
void	SetImageSize (int w, int h)
void	SetPostTransform (double offsetX, double offsetY, double deltaAngle)
void	SetPostTransformMatrix (ILTransform *tf)
void	SetPostTransformMatrix23 (LMatrix23 *data)
void	SetPostTransformMatrix33 (LMatrix33 *data)
void	WorldToImage (double worldPointX, double worldPointY, double *imagePointX, double *imagePointY)
Public Member Functions inherited from ILObject
ILObject *	Copy ()
LPVErrorCode	Load (LString filename)
void	Reset ()
LPVErrorCode	Save (LString filename)
BOOL	Valid ()

Properties
LPVDirection	AxisDirX [get, set]
	The new direction of the x axis. By default, x axis is pointing to the right.
LPVDirection	AxisDirY [get, set]
	The new direction of the y axis. By default, y axis is pointing down.
double	ScaleX [get, set]
	The scale factor of the x coordinates.
double	ScaleY [get, set]
	The scale factor of the y coordinates.
double	Theta [get, set]
	The delta clockwise rotation angle of the coordinates.
Properties inherited from ILCalib
double	CalibError [get]
	The overall RMS re-projection error for the calibration, calculated based on the distances between the image points and the projected (using the optimized calibration matrices) world points. It's defined as: \( \sqrt{ \frac{1}{n} \sum_{i=0}^{n} distance(p^{image}_i, p^{proj}_i)^2 } \).
LPVFixImageMode	FixImageMode [get, set]
	The mode to fix image used in FixImage(). More...
double	FixImageOffsetX [get, set]
	The x-coordinate offset (in pixel unit) of the fixed image used in FixImage(), used together with FixImageOffsetY. By default, it's 0, means no offset in x-coordinate. You may change the offset to translate the fixed image, for example move the inspect region to the center of the fixed image.
double	FixImageOffsetY [get, set]
	The y-coordinate offset (in pixel unit) of the fixed image used in FixImage(), used together with FixImageOffsetX. By default, it's 0, means no offset in y-coordinate. You may change the offset to translate the fixed image, for example move the inspect region to the center of the fixed image.
double	FixImageScale [get, set]
	The scale of the fixed image used in FixImage(). By default, it's 1, means no scale. You may change the scale factor to zoom in/out the fixed image.
LPVInterpolationMethod	InterpolationMethod [get, set]
	The interpolation method used in fix the image for undistortion (and untilt). By default, it's LPVInterCubic.
LPVCalibModel	Model [get]
	The calibration model.
BOOL	UseCache [get, set]
	Whether to make use of cache which is used to speed-up the process of the image undistortion (and untilt), but consume more memory. By default, it's off.

Detailed Description

This interface provide functionalities of the custom camera model.

This is a simple model for user to define the calibration manually, for simple scale, translation and rotation.
This model does not support distortion calibration.

To use this interface, you should create a LCalibCustom object.

Example Code

C++

ILCalibCustomPtr calib = LCalibCustom::Create();
// create the coordinates at the center of the image
calib->AxisDirX = LPVAxisRight;
calib->AxisDirY = LPVAxisUp;
calib->MoveOriginTo(w / 2, h / 2);
LPVErrorCode err = calib->Calibrate();
if (err != LPVErrorCode::LPVNoError || !calib->IsCalibrated()) return;

C#

LCalibCustom calib = new LCalibCustom();
// create the coordinates at the center of the image
calib.AxisDirX = LPVAxisRight;
calib.AxisDirY = LPVAxisUp;
calib.MoveOriginTo(w / 2, h / 2);
LPVErrorCode err = calib.Calibrate();
if (err != LPVErrorCode.LPVNoError || !calib.IsCalibrated()) return;

COM

ILCalibCustomPtr calib = LCalibCustom::Create();
// or, ILCalibCustomPtr calib(__uuidof(LCalibCustom)), for absence of built-in Create functions (before 2.2.0)
// create the coordinates at the center of the image
calib->AxisDirX = LPVAxisRight;
calib->AxisDirY = LPVAxisUp;
calib->MoveOriginTo(w / 2, h / 2);
LPVErrorCode err = calib->Calibrate();
if (err != LPVErrorCode::LPVNoError || !calib->IsCalibrated()) return;

Member Function Documentation

MoveOriginTo()

void MoveOriginTo	(	double	x,
		double	y
	)

Move the origin of the coordinates to the specified point. By default, the origin is the left-top corner of the image.

Parameters

[in]	x	The x-coordinate of the new origin in the origin image coordinates.
[in]	y	The y-coordinate of the new origin in the origin image coordinates.