CogAutoSelect.GetDiagImages Method

CogAutoSelect GetDiagImages Method

Cognex VisionPro 9.7

Produce the actual image and mask that would be processed if the Execute method were called with the supplied input image and region. This method is provided as a diagnostic aid to help the user visualize the actual image and mask that will be used at run time.

Namespace: Cognex.VisionPro.AutoSelect
Assembly: Cognex.VisionPro.AutoSelect (in Cognex.VisionPro.AutoSelect.dll) Version: 73.0.0.0

Syntax

C++

Copy to Clipboard Print

public void GetDiagImages(
	CogImage8Grey inputImage,
	ICogRegion inputRegion,
	ref CogImage8Grey diagImage,
	ref CogImage8Grey diagMask
)

public void GetDiagImages(
	CogImage8Grey inputImage,
	ICogRegion inputRegion,
	ref CogImage8Grey diagImage,
	ref CogImage8Grey diagMask
)

Public Sub GetDiagImages ( 
	inputImage As CogImage8Grey,
	inputRegion As ICogRegion,
	ByRef diagImage As CogImage8Grey,
	ByRef diagMask As CogImage8Grey
)

Public Sub GetDiagImages ( 
	inputImage As CogImage8Grey,
	inputRegion As ICogRegion,
	ByRef diagImage As CogImage8Grey,
	ByRef diagMask As CogImage8Grey
)

public:
void GetDiagImages(
	CogImage8Grey^ inputImage, 
	ICogRegion^ inputRegion, 
	CogImage8Grey^% diagImage, 
	CogImage8Grey^% diagMask
)

public:
void GetDiagImages(
	CogImage8Grey^ inputImage, 
	ICogRegion^ inputRegion, 
	CogImage8Grey^% diagImage, 
	CogImage8Grey^% diagMask
)

Parameters

inputImage: Type: Cognex.VisionPro CogImage8Grey
The image to be evaluated.

inputRegion: Type: Cognex.VisionPro ICogRegion
An optional region. May be null. If supplied, this region is used to limit the amount of processing performed on the input image. This is done in conjunction with the RegionMode property, which may be either PixelAlignedBoundingBox or PixelAlignedBoundingBoxAdjustMask. If no inputRegion is supplied, the entire input image is processed.

diagImage: Type: Cognex.VisionPro CogImage8Grey
The actual image that would be processed. This image reflects the impact of the supplied region, if any, as well as the current region mode.

diagMask: Type: Cognex.VisionPro CogImage8Grey
The actual mask that would be used during processing. This mask image reflects the region if one was supplied, the region mode, and the input image mask if one was supplied. If no mask would be used during processing then this parameter is set to null.

Exceptions

Exception	Condition
ArgumentNullException	If the supplied input image argument is null.