CogIPOneImageSubSampler.Execute Method

CogIPOneImageSubSampler Execute Method

Cognex VisionPro 9.25 SR1

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

Namespace: Cognex.VisionPro.ImageProcessing
Assembly: Cognex.VisionPro.ImageProcessing (in Cognex.VisionPro.ImageProcessing.dll) Version: 93.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 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
CogOperatorNoInputImageException	inputImage is NULL.
CogImageNoPixelsException	inputImage is not allocated.
CogOperatorInvalidRegionException	regionMode is AffineTransform but region is not of type CogRectangleAffine.
ArgumentException	regionMode is not AffineTransform or PixelAlignedBoundingBox.

Remarks

Performs a one-image operation using the input image and the region to produce the output image.