CogSurfaceFX.Contrast Property

CogSurfaceFX Contrast Property

Cognex VisionPro

Gets or sets the contrast. The contrast factor for the output image.

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

Syntax

C++

Copy to Clipboard Print

public double Contrast { get; set; }

public double Contrast { get; set; }

Public Property Contrast As Double 
	Get 
	Set

Public Property Contrast As Double 
	Get 
	Set

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

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

Property Value

Type: Double
The default value is 10.

Events

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

Exceptions

Exception	Condition
ArgumentOutOfRangeException	The supplied value is less than zero or greater than 100.
ObjectDisposedException	If the object has been disposed.

Remarks

Contrast specifies the range before clipping occurs when mapping the raw surface irregularity values into the output image. Increasing Contrast scales up the intensity difference between pixels in the output image.