CogPMRedLineZoneScale.Nominal Property

CogPMRedLineZoneScale Nominal Property

Cognex VisionPro 9.8 SR1

Gets or sets the nominal scale for the scale degree of freedom zone.

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

Syntax

C++

Copy to Clipboard Print

public double Nominal { get; set; }

public double Nominal { get; set; }

Public Property Nominal As Double 
	Get 
	Set

Public Property Nominal As Double 
	Get 
	Set

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

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

Property Value

Type: Double
The nominal scale. Default value is one.

Events

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

Exceptions

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

Remarks

The nominal scale is only used if the Configuration property is set to Nominal. In this case PMRedLine will only look for pattern instances at the nominal scale that you specify; it will not search at any other scale. If the pattern, at the nominal scale, is a high-scoring match to the runtime image features it may be returned as a result. The reported scale of the result will be exactly the nominal value.

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