CogPMRedLineZoneScale.High Property

CogPMRedLineZoneScale High Property

Cognex VisionPro

Gets or sets the high limit for the scale degree of freedom zone.

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

public double High { get; set; }

Public Property High As Double 
	Get 
	Set

Public Property High As Double 
	Get 
	Set

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

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

Property Value

Type: Double
The high limit of the scale range. Default value is 1.2.

Events

Event Type	Reason
ICogChangedEvent Changed	Fires when this property changes. The following state flag may be affected: SfHigh
ICogChangedEvent Changed	Fires when this property changes and the low limit is also changed. The following state flags may be affected: SfHigh SfLow

Exceptions

Exception	Condition
ArgumentOutOfRangeException	The supplied value is less than or equal to zero.

Remarks

The high limit is only used if the Configuration property is set to LowHigh. In this case PMRedLine will find pattern instances whose result scale lies between the low and high limit values.

The result scale can be accessed using the Scaling property of the CogTransform2DLinear returned by the GetPose method of the CogPMRedLineResult class.

Setting the high limit to a value smaller than the low limit also sets the low limit to the new value.