CogCNLSearchRunParams.SearchRegionMode Property

CogCNLSearchRunParams SearchRegionMode Property

Cognex VisionPro

Mode which specifies how the search region is to be applied to the input image of a CNLSearch inspection.

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

Syntax

C++

Copy to Clipboard Print

public CogRegionModeConstants SearchRegionMode { get; set; }

public CogRegionModeConstants SearchRegionMode { get; set; }

Public Property SearchRegionMode As CogRegionModeConstants 
	Get 
	Set

Public Property SearchRegionMode As CogRegionModeConstants 
	Get 
	Set

public:
property CogRegionModeConstants SearchRegionMode {
	CogRegionModeConstants get ();
	void set (CogRegionModeConstants value);
}

public:
property CogRegionModeConstants SearchRegionMode {
	CogRegionModeConstants get ();
	void set (CogRegionModeConstants value);
}

Property Value

Type: CogRegionModeConstants

Events

Event Type	Reason
CogCNLSearchRunParams Changed	Fires when the value of this property changes. The following state flag may be affected: SfSearchRegionMode

Event Type

Reason

CogCNLSearchRunParams Changed

Fires when the value of this property changes.

The following state flag may be affected:

SfSearchRegionMode

Exceptions

Exception	Condition
ArgumentException	The supplied value is one of the supported CogRegionModeConstants.

Remarks

Mode which specifies how the SearchRegion is to be applied to the InputImage of a CNLSearch inspection.

The CNLSearch tool only supports the PixelAlignedBoundingBox and AffineTransform region modes. If you specify a SearchRegionMode other than a CogRectangle, then the actual portion of the InputImage that is searched is a pixel-aligned bounding rectangle that encloses the supplied SearchRegionMode (unless the SearchRegionMode is a CogRectangleAffineand the SearchRegionMode is AffineTransform.