CogAcqSample.SampleX Property

CogAcqSample SampleX Property

Cognex VisionPro 9.20

Get or set X sampling.

Namespace: Cognex.VisionPro.Implementation.Internal
Assembly: Cognex.VisionPro.Core (in Cognex.VisionPro.Core.dll) Version: 80.0.0.0

Syntax

C++

Copy to Clipboard Print

public virtual int SampleX { get; set; }

public virtual int SampleX { get; set; }

Public Overridable Property SampleX As Integer 
	Get 
	Set

Public Overridable Property SampleX As Integer 
	Get 
	Set

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

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

Property Value

Type: Int32

Implements

ICogAcqSample SampleX

Events

Event Type	Reason
ICogChangedEvent Changed	Fires when the value changes. The following state flag may be affected: SfSampleX

Event Type

Reason

ICogChangedEvent Changed

Fires when the value changes.

The following state flag may be affected:

SfSampleX

Exceptions

Exception	Condition
ArgumentException	The new value is < 0.

Remarks

Sets or gets x-sampling. You can use subsampling to reduce the image size and may result in faster acquisitions. Subsample values specify the ration of full-frame pixels to sampled pixels. For example, setting SampleX to 8 specifies an 8:1 reduction in the number of pixels along the x-axis.

If SampleValuesLocked is True, changing this value sets SampleY to the same value.

Default Value: 1, no subsampling