CogSearchMaxRunParams.RelativeBrightnessEnabled Property

CogSearchMaxRunParams RelativeBrightnessEnabled Property

Cognex VisionPro 9.8 SR1

Gets or sets whether to enable relative brightness. If true then RelativeBrightnessRangeLow and RelativeBrightnessRangeHigh properties will be used to search only the patterns within the defined relative brightness range. If false then RelativeBrightnessRangeLow and RelativeBrightnessRangeHigh properties are ignored during SearchMax search.

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

Syntax

C++

Copy to Clipboard Print

public bool RelativeBrightnessEnabled { get; set; }

public bool RelativeBrightnessEnabled { get; set; }

Public Property RelativeBrightnessEnabled As Boolean 
	Get 
	Set

Public Property RelativeBrightnessEnabled As Boolean 
	Get 
	Set

public:
property bool RelativeBrightnessEnabled {
	bool get ();
	void set (bool value);
}

public:
property bool RelativeBrightnessEnabled {
	bool get ();
	void set (bool value);
}

Property Value

Type: Boolean
True if relative brightness is enabled; otherwise, false. Default value is false.

Events

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

Event Type

Reason

ICogChangedEvent Changed

Fires when this property changes.

The following state flag may be affected:

SfRelativeBrightnessEnabled

Remarks

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.