CogCalibCheckerboardTool.Run Method

CogCalibCheckerboardTool Run Method

Cognex VisionPro 9.5

Runs the tool using the current parameter settings.

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

Syntax

C++

Copy to Clipboard Print

public override void Run()

public override void Run()

Public Overrides Sub Run

Public Overrides Sub Run

public:
virtual void Run() override

public:
virtual void Run() override

Implements

ICogTool Run

Events

Event Type	Reason
ICogTool Running	Fires before the tool runs.
ICogChangedEvent Changed	Fires when the tool runs. If the run was successful, results are generated; if the run was not successful, no results are generated and the previous results are cleared. Use RunStatus after CogCalibCheckerboardTool returns or in a event handler to determine whether a run was successful or unsuccessful. The following state flags may be affected: SfOutputImage
ICogTool Ran	Fires after the tool runs.

Event Type

Reason

ICogTool Running

Fires before the tool runs.

ICogChangedEvent Changed

Fires when the tool runs. If the run was successful, results are generated; if the run was not successful, no results are generated and the previous results are cleared. Use RunStatus after CogCalibCheckerboardTool returns or in a event handler to determine whether a run was successful or unsuccessful.

The following state flags may be affected:

SfOutputImage

ICogTool Ran

Fires after the tool runs.

Exceptions

Exception	Condition
CogSecurityViolationException	Security is not enabled for this vision tool. See Resolving Security-Related Error Messages for more information.
CogToolNoOperatorException	Calibration is NULL.
CogOperatorNoInputImageException	InputImage is NULL.
CogImageBadTypeException	InputImage is not an CogImage8Grey.
CogOperatorNoRunParamsException	RunParams is NULL.
CogCalibFixCannotWarpException	InputImage does not contain all the pixels required by the nonlinear warper or he transform between the selected space of InputImage, or its pixels differ by more than a whole-pixel shift from the similar transformation object contained in the CalibrationImage.
CogCalibFixNotCalibratedException	This object has not been calibrated.

Remarks

Runs the tool. If ComputationMode is PerspectiveAndRadialWarp, the tool creates a new output image by warping the pixels in the InputImage to account for radial and perspective distortion, then attaches the computed calibration transformation to the new image's coordinate space tree.

If ComputationMode is Linear, the tool copies the InputImage to the OutputImage, then attaches the computed calibration transformation to the new image's coordinate space tree.

Note: You must call Calibrate before attempting to run this tool.

Note: This method does not actually raise the exceptions listed below. Use the RunStatus property to obtain a ICogRunStatus reference. Then use its Exception property to see if the Run method raised any exceptions.