CogSearchMaxRunParams.SearchImageMask Property

CogSearchMaxRunParams SearchImageMask Property

Cognex VisionPro

Gets or sets the mask that is used when running the CogSearchMax. The mask allows the user to identify areas of the run-time image as "Care" or "Don't Care". The mask is aligned to the run-time input image using the SearchImageMaskOffsetX and SearchImageMaskOffsetY values.

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

Syntax

C++

Copy to Clipboard Print

public CogImage8Grey SearchImageMask { get; set; }

public CogImage8Grey SearchImageMask { get; set; }

Public Property SearchImageMask As CogImage8Grey 
	Get 
	Set

Public Property SearchImageMask As CogImage8Grey 
	Get 
	Set

public:
property CogImage8Grey^ SearchImageMask {
	CogImage8Grey^ get ();
	void set (CogImage8Grey^ value);
}

public:
property CogImage8Grey^ SearchImageMask {
	CogImage8Grey^ get ();
	void set (CogImage8Grey^ value);
}

Property Value

Type: CogImage8Grey
The mask for the search image. Default value is NULL.

Events

Event Type	Reason
ICogChangedEvent Changed	Fires when this property changes. The following state flag may be affected: SfSearchImageMask

Event Type

Reason

ICogChangedEvent Changed

Fires when this property changes.

The following state flag may be affected:

SfSearchImageMask

Exceptions

Exception	Condition
InvalidOperationException	Thrown when you attempt to set this to an image with pixel values not 0 or 255.