CogCNLSearchRunParams.XYOverlap Property

CogCNLSearchRunParams XYOverlap Property

Cognex VisionPro

The maximum allowed percentage (0 to 1,inclusive) of overlap between two pattern instances. If the overlapping area of the two pattern instances is greater than the specified percentage, then the pattern instance with the lower score is discarded.

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 double XYOverlap { get; set; }

public double XYOverlap { get; set; }

Public Property XYOverlap As Double 
	Get 
	Set

Public Property XYOverlap As Double 
	Get 
	Set

public:
property double XYOverlap {
	double get ();
	void set (double value);
}

public:
property double XYOverlap {
	double get ();
	void set (double value);
}

Property Value

Type: Double

Events

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

Event Type

Reason

CogCNLSearchRunParams Changed

Fires when the value of this property changes.

The following state flag may be affected:

SfXYOverlap

Exceptions

Exception	Condition
ArgumentException	The supplied value is less than 0.0 or greater than 1.0.

Remarks

The maximum allowed percentage (0.0 through 1.0) of overlap between two pattern instances. If the overlapping area of the two pattern instances is greater than the specified percentage, then the pattern instance with the lower score is discarded.

By default, CNLSearch does not return pattern instances that overlap at all (the default overlap threshold is 1.0). By specifying a value of less than 1.0, you can obtain multiple overlapping pattern instances.

Default Value: 1.0