CogPolarUnwrapTool.Run Method

CogPolarUnwrapTool Run Method

Cognex VisionPro 9.5

Runs the tool using the current parameter settings.

Namespace: Cognex.VisionPro.ImageProcessing
Assembly: Cognex.VisionPro.ImageProcessing (in Cognex.VisionPro.ImageProcessing.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 CogPolarUnwrapTool 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 CogPolarUnwrapTool 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	RunParams is NULL.
CogImageBadTypeException	InputImage is not an 8-bit image.
CogImageNoPixelsException	InputImage is not allocated.
ArgumentException	Region is NULL.
CogOperatorInvalidRegionException	Region is neither a CogCircularAnnulusSection nor a CogEllipticalAnnulusSection.
CogTransformNotLinearException	The transform from the selected space of the Region to the pixel space of InputImage is not linear.
CogImageClippedException	Some of the sampling points require data that is outside the InputImage.
CogImageBadSelectedSpaceNameException	The selected space name of InputImage is not a valid name.
CogImageBadSelectedSpaceNameException	The selected space name of InputImage does not exist within InputImage's space tree.
CogImageBadSelectedSpaceNameException	The selected space name of InputImage is not unique within InputImage's space tree.
CogOperatorInvalidRegionException	The selected space name of Region is not a valid name.
CogOperatorInvalidRegionException	The selected space name of Region does not exist within InputImage's space tree.
CogOperatorInvalidRegionException	The selected space name of Region is not unique within InputImage's space tree.

Remarks

Unwraps the supplied InputImage using the supplied RunParams and placing the result in the OutputImage.

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.