CogSearchMaxRunParams.RelativeBrightnessRangeHigh Property

CogSearchMaxRunParams RelativeBrightnessRangeHigh Property

Cognex VisionPro 9.5

Gets or sets the highest 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: 69.0.0.0

Syntax

C++

Copy to Clipboard Print

public double RelativeBrightnessRangeHigh { get; set; }

public double RelativeBrightnessRangeHigh { get; set; }

Public Property RelativeBrightnessRangeHigh As Double 
	Get 
	Set

Public Property RelativeBrightnessRangeHigh As Double 
	Get 
	Set

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

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

Property Value

Type: Double
The highest acceptable contrast. Default value is 100.

Events

Event Type	Reason
ICogChangedEvent Changed	Fires when this property changes. The following state flag may be affected: SfRelativeBrightnessRangeHigh
ICogChangedEvent Changed	Fires when both the RelativeBrightnessRangeHigh and the RelativeBrightnessRangeLow are changed. The following state flags may be affected: SfRelativeBrightnessRangeHigh SfRelativeBrightnessRangeLow

Event Type

Reason

ICogChangedEvent Changed

Fires when this property changes.

The following state flag may be affected:

SfRelativeBrightnessRangeHigh

ICogChangedEvent Changed

Fires when both the RelativeBrightnessRangeHigh and the RelativeBrightnessRangeLow are changed.

The following state flags may be affected:

SfRelativeBrightnessRangeHigh
SfRelativeBrightnessRangeLow

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 less than the RelativeBrightnessRangeLow, the RelativeBrightnessRangeLow is set to the new value.

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