CogSearchMaxRunParams.ContrastRangeLow Property

CogSearchMaxRunParams ContrastRangeLow Property

Cognex VisionPro

Gets or sets the lowest acceptable contrast for a located pattern. Contrast is the ratio of the standard deviation of the corresponding care pixels in the located pattern to the standard deviation of the care pixels in the trained pattern.

Namespace: Cognex.VisionPro.SearchMax
Assembly: Cognex.VisionPro.SearchMax (in Cognex.VisionPro.SearchMax.dll) Version: 65.1.0.0

Syntax

C++

Copy to Clipboard Print

public double ContrastRangeLow { get; set; }

public double ContrastRangeLow { get; set; }

Public Property ContrastRangeLow As Double 
	Get 
	Set

Public Property ContrastRangeLow As Double 
	Get 
	Set

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

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

Property Value

Type: Double
The lowest acceptable contrast. Default value is 0.

Events

Event Type	Reason
ICogChangedEvent Changed	Fires when this property changes. The following state flag may be affected: SfContrastRangeLow
ICogChangedEvent Changed	Fires when both the ContrastRangeLow and the ContrastRangeHigh are changed. The following state flags may be affected: SfContrastRangeLow SfContrastRangeHigh

Event Type

Reason

ICogChangedEvent Changed

Fires when this property changes.

The following state flag may be affected:

SfContrastRangeLow

ICogChangedEvent Changed

Fires when both the ContrastRangeLow and the ContrastRangeHigh are changed.

The following state flags may be affected:

SfContrastRangeLow
SfContrastRangeHigh

Exceptions

Exception	Condition
ArgumentOutOfRangeException	Thrown when you attempt to set this to a value less than 0.

Remarks

The ContrastRangeHigh must be greater than or equal to the ContrastRangeLow. If this property is set to a value greater than the ContrastRangeHigh, the ContrastRangeHigh is set to the new value.

If ContrastEnabled is false, then this property ContrastRangeLow is ignored in SearchMax search.