CogCalibCheckerboard.Calibrate Method

CogCalibCheckerboard Calibrate Method

Cognex VisionPro

Computes the mapping to calibrated space using the current CalibrationImage and related parameters. If successful, sets the Calibrated property to True, updates the computed transforms, and makes this object ready to run via the Execute method.

Namespace: Cognex.VisionPro.CalibFix
Assembly: Cognex.VisionPro.CalibFix (in Cognex.VisionPro.CalibFix.dll) Version: 65.1.0.0

Syntax

C++

Copy to Clipboard Print

public void Calibrate()

public void Calibrate()

Public Sub Calibrate

Public Sub Calibrate

public:
void Calibrate()

public:
void Calibrate()

Events

Event Type	Reason
CogCalibCheckerboard Changed	Fires when calibration is completed successfully. This event may also fire if calibration fails depending upon which calibration steps were completed prior to this call to this method. Calibration StepState Flags AffectedStep 1 SfNumPoints SfGetUncalibratedPointX SfGetUncalibratedPointY SfGetRawCalibratedPointX SfGetRawCalibratedPointY Step 2 and higher SfCalibrated SfGetComputedUncalibratedFromCalibratedTransform SfGetComputedUncalibratedFromRawCalibratedTransform SfComputedRMSError SfGetInfoStrings Step 3 and higher with nonlinear warping SfGetOutputImageRootFromCalibratedTransform (step 5 and higher with nonlinear warping) SfOutputImageMask (step 5 and higher with nonlinear warping) SfUndistortedCalibrationImage (step 5 and higher with nonlinear warping) SfUndistortedCalibrationImageMask (step 5 and higher with nonlinear warping)

Event Type

Reason

CogCalibCheckerboard Changed

Fires when calibration is completed successfully. This event may also fire if calibration fails depending upon which calibration steps were completed prior to this call to this method. Calibration StepState Flags AffectedStep 1

Step 2 and higher

Step 3 and higher with nonlinear warping

SfGetOutputImageRootFromCalibratedTransform (step 5 and higher with nonlinear warping)
SfOutputImageMask (step 5 and higher with nonlinear warping)
SfUndistortedCalibrationImage (step 5 and higher with nonlinear warping)
SfUndistortedCalibrationImageMask (step 5 and higher with nonlinear warping)

Exceptions

Exception	Condition
CogCalibFixDataMatrixDecodeErrorException	A DataMatrix fiducial was expected, but no DataMatrix code that was successfully found could be successfully decoded.
CogCalibFixCheckerboardMathUnstableException	The object cannot be calibrated because the located tile vertices yield a numerically unstable result. Verify that you have supplied a well-focused high-contrast image of the calibration plate. Use the diagnostic graphics to make sure that the tile vertices have been located correctly, and make sure that you have specified correct values for the tile size.
CogImageBadTypeException	CalibrationImage is not a CogImage8Grey.
CogSecurityViolationException	Security is not enabled for this vision tool. See Resolving Security Related Error Messages for more information.
CogCalibFixNoCalibrationImageException	CalibrationImage is NULL.
CogImageNoPixelsException	CalibrationImage is not allocated.
CogCalibFixNoFiducialException	A fiducial mark was expected but not found.
CogCalibFixBadDestRectException	The WarpDestinationRectangle does not intersect any filled pixels of the undistorted image.
CogCalibFixTooFewVerticesException	Fewer than nine tile vertices were found.
CogCalibFixDataMatrixNotFoundException	A DataMatrix fiducial was expected but not found.
CogCalibFixDataMatrixParseErrorException	A DataMatrix fiducial was expected, but no DataMatrix code thas was successfully decoded could be successfully parsed.

Remarks