CogPMRedLineTool.SearchRegion Property

CogPMRedLineTool SearchRegion Property

Cognex VisionPro 9.20

Gets or sets the search region. Only the portion of the input image that lies within this region will be searched by PMRedLine. If the supplied region object is null, the entire input image will be searched.

Namespace: Cognex.VisionPro.PMRedLine
Assembly: Cognex.VisionPro.PMRedLine (in Cognex.VisionPro.PMRedLine.dll) Version: 80.0.0.0

Syntax

C++

Copy to Clipboard Print

public ICogRegion SearchRegion { get; set; }

public ICogRegion SearchRegion { get; set; }

Public Property SearchRegion As ICogRegion 
	Get 
	Set

Public Property SearchRegion As ICogRegion 
	Get 
	Set

public:
property ICogRegion^ SearchRegion {
	ICogRegion^ get ();
	void set (ICogRegion^ value);
}

public:
property ICogRegion^ SearchRegion {
	ICogRegion^ get ();
	void set (ICogRegion^ value);
}

Property Value

Type: ICogRegion
The search region. Default value is null.

Events

Event Type	Reason
ICogChangedEvent Changed	Fires when this property changes. The following state flags may be affected: SfSearchRegion SfCreateCurrentRecord

Remarks

The SearchRegionMode in the CogPMRedLineRunParams class specifies exactly how the search region will be applied to the InputImage.

You can restrict what portions of the input image are searched by PMRedLine. There are two restriction methods you can use:

You can exclude one contiguous area of the image using the SearchRegion.
You can exclude multiple non-contiguous areas using the SearchImageMask of the CogPMRedLineRunParams class.

You can use none, either, or both of these restriction methods.