CogIPOneImageTool.Run Method

CogIPOneImageTool Run Method

Cognex VisionPro 9.25 SR1

Runs the tool using the current parameter settings.

Namespace: Cognex.VisionPro.ImageProcessing
Assembly: Cognex.VisionPro.ImageProcessing (in Cognex.VisionPro.ImageProcessing.dll) Version: 93.1.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 CogIPOneImageTool returns or in a Ran 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 CogIPOneImageTool returns or in a Ran 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
CogOperatorNoInputImageException	InputImage is NULL.
CogToolNoOperatorException	The tool has no CogIPOneImageOperators.
CogImageNoPixelsException	InputImage is not allocated.
CogOperatorInvalidRegionException	RegionMode is cogRegionModeAffineTransform but Region is not of type CogRectangleAffine.
ArgumentException	RegionMode is not cogRegionModeAffineTransform or cogRegionModePixelAlignedBoundingBox.

Remarks

Executes each of the tool's CogIPOneImageOperators in sequence.

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.