CogSurfaceFX.Execute Method

CogSurfaceFX Execute Method

Cognex VisionPro

Generate the output image using the input images held by the InputVisionData, the properties of this class and the given region.

Namespace: Cognex.VisionPro.SurfaceFX
Assembly: Cognex.VisionPro.SurfaceFX (in Cognex.VisionPro.SurfaceFX.dll) Version: 65.1.0.0

Syntax

C++

Copy to Clipboard Print

public ICogImage Execute(
	CogVisionDataContainer inputVisionData,
	ICogRegion region
)

public ICogImage Execute(
	CogVisionDataContainer inputVisionData,
	ICogRegion region
)

Public Function Execute ( 
	inputVisionData As CogVisionDataContainer,
	region As ICogRegion
) As ICogImage

Public Function Execute ( 
	inputVisionData As CogVisionDataContainer,
	region As ICogRegion
) As ICogImage

public:
ICogImage^ Execute(
	CogVisionDataContainer^ inputVisionData, 
	ICogRegion^ region
)

public:
ICogImage^ Execute(
	CogVisionDataContainer^ inputVisionData, 
	ICogRegion^ region
)

Parameters

inputVisionData

Type: Cognex.VisionPro CogVisionDataContainer
The vision data container that the following:

4 input images. Each image is CogImage8Grey value.
a unique key with each image value.

region: Type: Cognex.VisionPro ICogRegion
An optional region of interest. If you do not specify a region, the entire image is processed.

Return Value

Type: ICogImage
The output image, showing the 3D surface curvature. The size of the output image is the same as the pixel-aligned bounding box of the region.

Exceptions

Exception	Condition
CogSecurityViolationException	Licensing for this operation cannot be confirmed. See Understanding VisionPro Security for more information.
CogImageNoPixelsException	inputVisionData contained images that have no allocated pixels.
CogImageBadTypeException	inputVisionData contains images that are not CogImage8Grey.
ArgumentException	region falls completely outside of the inputVisionData contained images. Or has an invalid SelectedSpaceName.
ArgumentNullException	If the inputVisionData is null.
ArgumentException	If the inputVisionData does not have the appropriate number of records.
CogOperatorNoInputImageException	If any of the values in the InputVisionData is null.
CogSpaceTreeInvalidNameSyntaxException	If any of the keys in the inputVisionData is not valid coordinate space name.
ArgumentException	If any of the non-null values are not an ICogImage.
ObjectDisposedException	If the object has been disposed.