CogPMRedLineRunParams.XYOverlap Property

CogPMRedLineRunParams XYOverlap Property

Cognex VisionPro

Gets or sets the area overlap threshold.

Namespace: Cognex.VisionPro.PMRedLine
Assembly: Cognex.VisionPro.PMRedLine (in Cognex.VisionPro.PMRedLine.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
The area overlap threshold. Default value is 0.7.

Events

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

Exceptions

Exception	Condition
ArgumentOutOfRangeException	The supplied value is less than zero or greater than one.

Remarks

Two result candidates are said to overlap in area if the fraction of their area that overlaps is greater than the given XYOverlap threshold. The valid range of the threshold is from zero to one.

PMRedLine discards the weaker pattern instance when two pattern instances overlap for all degrees of freedom (DOF) as well as area. See the Overlap property of the angle DOF zone, and the Overlap property of the scale DOF zone for more information.