CogCalibNPointToNPointTool Run Method Cognex VisionPro
Runs the tool using the current parameter settings.

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

public override void Run()

Implements

ICogTool Run 
Events

Event TypeReason
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 CogCalibNPointToNPointTool returns or in a event handler to determine whether a run was successful or unsuccessful.

The following state flags may be affected:

ICogTool Ran

Fires after the tool runs.

Exceptions

ExceptionCondition
CogToolNoOperatorException

The Calibration object is NULL.

Remarks

Attaches the adjusted calibrated space to the coordinate space tree of the input image using the Execute(ICogImage, CogCalibNPointToNPointRunParams) method of the tool's CogCalibNPointToNPoint, creates a new output image for use by other tools, and builds inspections records. It is the client's responsibility to Calibrate  the UncalibratedFromCalibrated transform before calling the Run  method.

For each invocation, this method creates a new CogRunStatus. For each successful invocation, it creates a new output image.

Note: For more information about the tool's execution, see the Execute(ICogImage, CogCalibNPointToNPointRunParams) method of the tool's CogCalibNPointToNPoint.

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.

See Also