CogIPOneImageConvolveNxM.Execute Method

CogIPOneImageConvolveNxM Execute Method

Cognex VisionPro 9.22 SR1

Perform a single image operation using the input image to produce the output image.

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

Syntax

C++

Copy to Clipboard Print

public virtual ICogImage Execute(
	ICogImage inputImage,
	CogRegionModeConstants regionMode,
	ICogRegion region
)

public virtual ICogImage Execute(
	ICogImage inputImage,
	CogRegionModeConstants regionMode,
	ICogRegion region
)

Public Overridable Function Execute ( 
	inputImage As ICogImage,
	regionMode As CogRegionModeConstants,
	region As ICogRegion
) As ICogImage

Public Overridable Function Execute ( 
	inputImage As ICogImage,
	regionMode As CogRegionModeConstants,
	region As ICogRegion
) As ICogImage

public:
virtual ICogImage^ Execute(
	ICogImage^ inputImage, 
	CogRegionModeConstants regionMode, 
	ICogRegion^ region
)

public:
virtual ICogImage^ Execute(
	ICogImage^ inputImage, 
	CogRegionModeConstants regionMode, 
	ICogRegion^ region
)

Parameters

inputImage: Type: Cognex.VisionPro ICogImage
The image to which the operator is applied.

regionMode: Type: Cognex.VisionPro CogRegionModeConstants
Specifies how the region should be applied to the input image.

region: Type: Cognex.VisionPro ICogRegion
A region that, together with the regionMode, specifies which part of the input image the operator applies to.

Return Value

Type: ICogImage
The image that results from applying this operator to the inputImage.

Implements

ICogIPOneImageOperator Execute(ICogImage, CogRegionModeConstants, ICogRegion)

Exceptions

Exception	Condition
CogOperatorInvalidRegionException	regionMode is AffineTransform but region is not of type CogRectangleAffine.
ArgumentException	regionMode is not either AffineTransform or PixelAlignedBoundingBox.
CogOperatorNoInputImageException	inputImage is NULL.
CogImageNoPixelsException	inputImage is not allocated.

Remarks

Performs a one-image operation using the input image and region to produce the output image. Note that the CogIPOneImageConvolveNxM operator normalizes the output pixel values to ensure that they do not overflow. The convolution value is divided by the sum of the positive kernel values, or the absolute value of the sum of the negative kernel values, whichever is larger.