CogIPTwoImageSubtract.Execute Method

CogIPTwoImageSubtract Execute Method

Cognex VisionPro 9.8 SR1

Interface for subtracting an image from another. InputImageB is subtracted from InputImageA.

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

Syntax

C++

Copy to Clipboard Print

public ICogImage Execute(
	ICogImage inputImageA,
	ICogImage inputImageB,
	ICogRegion regionA,
	ICogRegion regionB
)

public ICogImage Execute(
	ICogImage inputImageA,
	ICogImage inputImageB,
	ICogRegion regionA,
	ICogRegion regionB
)

Public Function Execute ( 
	inputImageA As ICogImage,
	inputImageB As ICogImage,
	regionA As ICogRegion,
	regionB As ICogRegion
) As ICogImage

Public Function Execute ( 
	inputImageA As ICogImage,
	inputImageB As ICogImage,
	regionA As ICogRegion,
	regionB As ICogRegion
) As ICogImage

public:
ICogImage^ Execute(
	ICogImage^ inputImageA, 
	ICogImage^ inputImageB, 
	ICogRegion^ regionA, 
	ICogRegion^ regionB
)

public:
ICogImage^ Execute(
	ICogImage^ inputImageA, 
	ICogImage^ inputImageB, 
	ICogRegion^ regionA, 
	ICogRegion^ regionB
)

Parameters

inputImageA: Type: Cognex.VisionPro ICogImage
The first image.

inputImageB: Type: Cognex.VisionPro ICogImage
The image to subtract from inputImageA.

regionA: Type: Cognex.VisionPro ICogRegion
A region that, together with RegionModeA, specifies which part of inputImageA to use.

regionB: Type: Cognex.VisionPro ICogRegion
A region that, together with RegionModeB, specifies which part of inputImageB to use.

Return Value

Type: ICogImage

The image generated by subtracting inputImageB from inputImageA

Exceptions

Exception	Condition
CogOperatorNoInputImageException	inputImageA or inputImageB is NULL.
CogImageNoPixelsException	inputImageA or inputImageB is not allocated.
CogOperatorInvalidRegionException	The selected space of one of the regions is not a valid space of the corresponding input image.
ArgumentException	RegionModeA or RegionModeB is not AffineTransform or PixelAlignedBoundingBox.
OutOfMemoryException	Could not allocate memory for OutputImage.
CogIPNoRegionOverlapException	The regions do not overlap.

Remarks

Generates a new image that is the result of subtracting the specified regions of the two input images. If the region parameter is Nothing, the entire image is used.