CogIPOneImageGaussSampler.MagnitudeShift Property

CogIPOneImageGaussSampler MagnitudeShift Property

Cognex VisionPro 9.25 SR1

Bitwise shifts the pixel values of the result. Valid shift values are from -7 to 7. Negative values will darken the result by dividing the pixel value results by 2 for each bit specified. Similarly, positive values will brighten by multiplying by 2.

Namespace: Cognex.VisionPro.ImageProcessing
Assembly: Cognex.VisionPro.ImageProcessing (in Cognex.VisionPro.ImageProcessing.dll) Version: 93.1.0.0

Syntax

C++

Copy to Clipboard Print

public int MagnitudeShift { get; set; }

public int MagnitudeShift { get; set; }

Public Property MagnitudeShift As Integer 
	Get 
	Set

Public Property MagnitudeShift As Integer 
	Get 
	Set

public:
property int MagnitudeShift {
	int get ();
	void set (int value);
}

public:
property int MagnitudeShift {
	int get ();
	void set (int value);
}

Property Value

Type: Int32

Events

Event Type	Reason
CogIPOneImageGaussSampler Changed	Fires when the value of this property changes. The following state flag may be affected: SfMagnitudeShift

Event Type

Reason

CogIPOneImageGaussSampler Changed

Fires when the value of this property changes.

The following state flag may be affected:

SfMagnitudeShift

Exceptions

Exception	Condition
ArgumentException	The magnitude shift value is < -7 or > +7.

Remarks

Shifts the pixel values of the resulting image using a bitwise shift. Valid values are from -7 to 7. Negative values effectively divide pixel values by two, darkening the resulting image. Positive values effectively multiply pixel values by two, lightening the resulting image. Note that a MagnitudeShift value greater than zero, when combined with SampleX or SampleY values greater than one, may result in output pixel value overflow.