CogSearchMaxRunParams.RelativeBrightnessRangeLow Property

CogSearchMaxRunParams RelativeBrightnessRangeLow Property

Cognex VisionPro

Gets or sets the lowest acceptable relative brightness for a located pattern. Relative brightness is the ratio of the mean of the corresponding care pixels in the located pattern to the mean 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 RelativeBrightnessRangeLow { get; set; }

public double RelativeBrightnessRangeLow { get; set; }

Public Property RelativeBrightnessRangeLow As Double 
	Get 
	Set

Public Property RelativeBrightnessRangeLow As Double 
	Get 
	Set

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

public:
property double RelativeBrightnessRangeLow {
	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: SfRelativeBrightnessRangeLow
ICogChangedEvent Changed	Fires when both the RelativeBrightnessRangeLow and the RelativeBrightnessRangeHigh are changed. The following state flags may be affected: SfRelativeBrightnessRangeLow SfRelativeBrightnessRangeHigh

Event Type

Reason

ICogChangedEvent Changed

Fires when this property changes.

The following state flag may be affected:

SfRelativeBrightnessRangeLow

ICogChangedEvent Changed

Fires when both the RelativeBrightnessRangeLow and the RelativeBrightnessRangeHigh are changed.

The following state flags may be affected:

SfRelativeBrightnessRangeLow
SfRelativeBrightnessRangeHigh

Exceptions

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

Remarks

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

If RelativeBrightnessEnabled is false, then this property RelativeBrightnessRangeLow is ignored in SearchMax search.