CogPMAlignRunParams.SearchRegionMode Property

CogPMAlignRunParams SearchRegionMode Property

Cognex VisionPro

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

Namespace: Cognex.VisionPro.PMAlign
Assembly: Cognex.VisionPro.PMAlign (in Cognex.VisionPro.PMAlign.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
CogPMAlignRunParams Changed	Fires when the value of this property changes. The following state flag may be affected: SfSearchRegionMode

Event Type

Reason

CogPMAlignRunParams 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 neither PixelAlignedBoundingBoxAdjustMask nor PixelAlignedBoundingBox.

Remarks

A value defined in CogRegionModeConstants that specifies how the search region is to be applied to the input image of a PMAlign inspection. If you specify PixelAlignedBoundingBoxAdjustMask for mode, the search will be performed on the masked input region. If you specify PixelAlignedBoundingBox the input region alone is used. If you do not supply a value for the SearchRegion argument to Execute(CogImage8Grey, ICogRegion, CogPMAlignRunParams) function, the value of this argument is ignored.

Default Value: PixelAlignedBoundingBoxAdjustMask