CogPatInspectPattern.Execute Method

CogPatInspectPattern Execute Method

Cognex VisionPro 9.5

Perform a PatInspect inspection on the provided input image. The Pose maps from "Pattern Space" to the selected space of the input image and is used to align the pattern with the features that will be inspected in the input image.

Namespace: Cognex.VisionPro.PatInspect
Assembly: Cognex.VisionPro.PatInspect (in Cognex.VisionPro.PatInspect.dll) Version: 69.0.0.0

Syntax

C++

Copy to Clipboard Print

public CogPatInspectResult Execute(
	CogImage8Grey inputImage,
	CogTransform2DLinear pose,
	CogPatInspectRunParams runParams
)

public CogPatInspectResult Execute(
	CogImage8Grey inputImage,
	CogTransform2DLinear pose,
	CogPatInspectRunParams runParams
)

Public Function Execute ( 
	inputImage As CogImage8Grey,
	pose As CogTransform2DLinear,
	runParams As CogPatInspectRunParams
) As CogPatInspectResult

Public Function Execute ( 
	inputImage As CogImage8Grey,
	pose As CogTransform2DLinear,
	runParams As CogPatInspectRunParams
) As CogPatInspectResult

public:
CogPatInspectResult^ Execute(
	CogImage8Grey^ inputImage, 
	CogTransform2DLinear^ pose, 
	CogPatInspectRunParams^ runParams
)

public:
CogPatInspectResult^ Execute(
	CogImage8Grey^ inputImage, 
	CogTransform2DLinear^ pose, 
	CogPatInspectRunParams^ runParams
)

Parameters

inputImage: Type: Cognex.VisionPro CogImage8Grey
The CogImage8Grey containing the features you want to analyze with the PatInspect tool.

pose: Type: Cognex.VisionPro CogTransform2DLinear
The CogTransform2DLinear that maps the alignment region in the input image to the alignment region of the training image.

runParams: Type: Cognex.VisionPro.PatInspect CogPatInspectRunParams
The CogPatInspectRunParams containing the parameters for how the PatInspect inspection will be performed and what data will be generated as part of the result.

Return Value

Type: CogPatInspectResult

The CogPatInspectResult containing the various match images and difference images the tool was configured to generate.

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.
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

Analyze the current inputImage with the PatInspect tool and generate the output images determined by the current set of runParams. The tool uses the pose to map from "Pattern Space" to the selected space of the input image and is used to align the pattern with the features that will be inspected in the input image.