CogBeadInspectPattern.Execute Method

CogBeadInspectPattern Execute Method

Cognex VisionPro 9.22 SR1

Examine the given inputImage for defects along the trained bead path. The analysis is performed using the supplied runParams.

Namespace: Cognex.VisionPro.EdgeInspect
Assembly: Cognex.VisionPro.EdgeInspect (in Cognex.VisionPro.EdgeInspect.dll) Version: 87.1.0.0

Syntax

public CogBeadInspectResult Execute(
	ICogVisionData inputImage,
	CogBeadInspectRunParams runParams
)

public CogBeadInspectResult Execute(
	ICogVisionData inputImage,
	CogBeadInspectRunParams runParams
)

Public Function Execute ( 
	inputImage As ICogVisionData,
	runParams As CogBeadInspectRunParams
) As CogBeadInspectResult

Public Function Execute ( 
	inputImage As ICogVisionData,
	runParams As CogBeadInspectRunParams
) As CogBeadInspectResult

public:
CogBeadInspectResult^ Execute(
	ICogVisionData^ inputImage, 
	CogBeadInspectRunParams^ runParams
)

public:
CogBeadInspectResult^ Execute(
	ICogVisionData^ inputImage, 
	CogBeadInspectRunParams^ runParams
)

inputImage: Type: Cognex.VisionPro ICogVisionData
The image to be searched. Must be of type CogImage8Grey.

runParams: Type: Cognex.VisionPro.EdgeInspect CogBeadInspectRunParams
The parameters that specify how to run this BeadInspect defect detection.

Type: CogBeadInspectResult
The BeadInspect result that contains analysis of the runtime image.

Exceptions

Exception	Condition
ArgumentNullException	inputImage is null.
ArgumentNullException	runParams is null.
CogSecurityViolationException	Licensing for this operation cannot be confirmed. See Understanding VisionPro Security for more information.
CogImageNoPixelsException	inputImage has no allocated pixels.
CogImageBadTypeException	inputImage is not a CogImage8Grey.
CogOperatorNotTrainedException	This pattern operator is not trained.
CogInvalidMaskOrFillEdgeLengthException	There was a mis-match between the number of calipers in the trained path and the length of the mask or fill edge lists in the provided runParams.
CogIllegalRuntimeTrainingParamsException	The coordinate spacing has varied between training time and runtime which has caused the trained values of BeadWidth or FixedWidth to no longer be valid values within the runtime coordinate space.

Remarks

For more detailed information on the defect categories, please reference CogBeadInspectDefectTypeConstants.

Note that this method expects the runtime path to be at exactly the trained position, it does not "search" for the path within a region.