CogShapePolarize.Execute Method

CogShapePolarize Execute Method

Cognex VisionPro 9.8

Execute will determine the polarity information along the provided shape based on data extracted from the input image. Polarity information indicates which side of the shape boundary is dark and which side is light.

Namespace: Cognex.VisionPro
Assembly: Cognex.VisionPro.Core (in Cognex.VisionPro.Core.dll) Version: 75.1.0.0

Syntax

C++

Copy to Clipboard Print

public ICogShapeModel Execute(
	ICogImage inputImage,
	ICogShapeModel shapeModel
)

public ICogShapeModel Execute(
	ICogImage inputImage,
	ICogShapeModel shapeModel
)

Public Function Execute ( 
	inputImage As ICogImage,
	shapeModel As ICogShapeModel
) As ICogShapeModel

Public Function Execute ( 
	inputImage As ICogImage,
	shapeModel As ICogShapeModel
) As ICogShapeModel

public:
ICogShapeModel^ Execute(
	ICogImage^ inputImage, 
	ICogShapeModel^ shapeModel
)

public:
ICogShapeModel^ Execute(
	ICogImage^ inputImage, 
	ICogShapeModel^ shapeModel
)

Parameters

inputImage: Type: Cognex.VisionPro ICogImage
The image to use for polarizing. shapeModel is applied to this image, based on its selected space and the coordinate space tree of this image.

shapeModel: Type: Cognex.VisionPro ICogShapeModel
The shape model to polarize.

Return Value

Type: ICogShapeModel

The polarized shape model.

Exceptions

Exception	Condition
ArgumentException	A NULL shape model was supplied.
CogOperatorNoInputImageException	inputImage is NULL
CogImageNoPixelsException	inputImage is not allocated.
CogImageBadSelectedSpaceNameException	The selected space of inputImage is not a valid space in inputImage's coordinate space tree; the selected space of inputImage is nonqualified and more than one instance of the name is present in inputImage's coordinate space tree; or the selected space of inputImage is not a legal space name.
CogOperatorInvalidShapeException	The selected space of shapeModel is not a valid space in inputImage's coordinate space tree; the selected space of shapeModel is nonqualified and more than one instance of the name is present in inputImage's coordinate space tree; or the selected space of shapeModel is not a legal space name.

Remarks

Determines the polarity information along the provided shape based on data extracted from the input image. Polarity information indicates which side of the shape boundary is dark and which side is light.