CogPatInspectTool.Run Method

CogPatInspectTool Run Method

Cognex VisionPro 9.7

Runs the tool using the current parameter settings.

Namespace: Cognex.VisionPro.PatInspect
Assembly: Cognex.VisionPro.PatInspect (in Cognex.VisionPro.PatInspect.dll) Version: 73.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 CogPatInspectTool returns or in a Ran 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.

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 CogPatInspectTool returns or in a Ran 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

Exception	Condition
CogSecurityViolationException	Security is not enabled for this vision tool. See Resolving Security-Related Error Messages for more information.
CogImageBadSelectedSpaceNameException	The selected space of InputImage is not a valid space of InputImage's coordinate space tree.
CogImageBadSelectedSpaceNameException	The selected space name of InputImage is a nonqualified space name and more than one instance of it exists in the space tree of InputImage.
CogImageBadSelectedSpaceNameException	The selected space name of InputImage is not a legal space name.
CogOperatorNoInputImageException	InputImage is NULL.
CogImageNoPixelsException	InputImage is not allocated.
CogOperatorNotTrainedException	The pattern is not trained.
CogToolNoOperatorException	Pattern is NULL.
CogPatInspectNormalizationFailedException	The portion of TrainRegion mapped onto InputImage does not contain enough data to perform normalization.
ArgumentException	Pose is NULL.
ArgumentException	RunParams is NULL.

Remarks

Compare the selected region of the input image to the trained pattern and generate one or more output images that represent the differences between the two.

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.