Cog3DAlignPattern.Execute Method

Cog3DAlignPattern Execute Method

Cognex VisionPro

Searchs the given inputVisionData for instances of this pattern. The search is performed using the supplied runParams within the given region.

Namespace: Cognex.VisionPro3D
Assembly: Cognex.VisionPro3D (in Cognex.VisionPro3D.dll) Version: 65.1.0.0

Syntax

public Cog3DAlignResults Execute(
	ICogVisionData inputVisionData,
	ICog3DShape region,
	Cog3DAlignRunParams runParams
)

public Cog3DAlignResults Execute(
	ICogVisionData inputVisionData,
	ICog3DShape region,
	Cog3DAlignRunParams runParams
)

Public Function Execute ( 
	inputVisionData As ICogVisionData,
	region As ICog3DShape,
	runParams As Cog3DAlignRunParams
) As Cog3DAlignResults

Public Function Execute ( 
	inputVisionData As ICogVisionData,
	region As ICog3DShape,
	runParams As Cog3DAlignRunParams
) As Cog3DAlignResults

public:
Cog3DAlignResults^ Execute(
	ICogVisionData^ inputVisionData, 
	ICog3DShape^ region, 
	Cog3DAlignRunParams^ runParams
)

public:
Cog3DAlignResults^ Execute(
	ICogVisionData^ inputVisionData, 
	ICog3DShape^ region, 
	Cog3DAlignRunParams^ runParams
)

inputVisionData: Type: Cognex.VisionPro ICogVisionData
The 3D input image to be searched.
Images of 3D data can be stored in a single CogImage16Range or stored in a CogVisionDataContainer as a matched pair, with one CogImage16Range holding the 3D data and one CogImage16Grey holding corresponding grey-level information. Either style of input is acceptable. Both objects are referred to by the term "vision data" and both support the ICogVisionData interface.

region: Type: Cognex.VisionPro3D ICog3DShape
An optional region of interest. It must be a Cog3DBox. The function only matches the pattern to 3D data points that fall inside this box. If you specify a null region, the entire input image is searched.

runParams: Type: Cognex.VisionPro3D Cog3DAlignRunParams
The parameters that specify how to run this 3DAlign search.

Type: Cog3DAlignResults
The 3DAlign results that were found. Results are sorted in order of decreasing score.

Exceptions

Exception	Condition
ArgumentNullException	inputVisionData is null.
ArgumentNullException	runParams is null.
CogSecurityViolationException	Licensing for this operation cannot be confirmed. See Understanding VisionPro Security for more information.
CogOperatorNotTrainedException	This pattern operator is not trained.
ArgumentOutOfRangeException	The inputVisionData is not a valid source of 3D image data. Images of 3D data can be stored in a single CogImage16Range or stored in a CogVisionDataContainer as a matched pair, with one CogImage16Range holding the 3D data and one CogImage16Grey holding corresponding grey-level information. Either style of input is acceptable. Both objects are referred to by the term "vision data" and both support the ICogVisionData interface.
InvalidOperationException	The region contains too few 3D points to allow searching. This might occur because the region falls completely outside of the inputVisionData, or has an invalid SelectedSpaceName3D.
CogTimeoutExpiredException	The pattern search took longer than the enabled Timeout value.