CogSobelEdgeTool.Run Method

CogSobelEdgeTool Run Method

Cognex VisionPro 9.20

Runs the tool using the current parameter settings.

Namespace: Cognex.VisionPro.ImageProcessing
Assembly: Cognex.VisionPro.ImageProcessing (in Cognex.VisionPro.ImageProcessing.dll) Version: 80.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 CogSobelEdgeTool returns or in a Ran event handler to determine whether a run was successful or unsuccessful. The following state flags may be affected: SfResult
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 CogSobelEdgeTool returns or in a Ran event handler to determine whether a run was successful or unsuccessful.

The following state flags may be affected:

SfResult

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.
CogOperatorNoInputImageException	CogSobelEdgeTool is NULL
CogImageNoPixelsException	CogSobelEdgeTool is not allocated.
CogToolNoOperatorException	RunParams is NULL
CogImageBadSelectedSpaceNameException	The selected space name of the InputImage is not a valid name.
CogImageBadSelectedSpaceNameException	The selected space name of InputImage does not exist in the InputImage's space tree.
CogImageBadSelectedSpaceNameException	The selected space name of InputImage is not unique within the InputImage's space tree
CogOperatorInvalidRegionException	The selected space of Region is not a valid space of InputImage.
CogOperatorInvalidRegionException	The selected space name of Region is a nonqualified space name and more than one instance of it exists in the space tree of InputImage.
CogOperatorInvalidRegionException	The selected space name of Region is not a legal space name.
CogOperatorInvalidRegionException	Region falls completely outside of InputImage. Clipping of Region is allowed.
ArgumentException	Region is some region other than an CogRectangleAffine and the RegionMode is AffineTransform.

Remarks

Performs Sobel Edge processing on the InputImage using the supplied RunParams. You can specify that analysis be limited to part of the InputImage by supplying a value for the Region property.

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.