CogPMAlignRunParams.GrainLimitCoarse Property

CogPMAlignRunParams GrainLimitCoarse Property

Cognex VisionPro

Coarse grain limit that will be used at run-time if GrainLimitsUsePattern is false. Coarse must be greater than or equal to fine. Setting coarse less than fine will also set fine to the new coarse value. Valid range is from 1.0 to 25.5 inclusive.

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

Syntax

C++

Copy to Clipboard Print

public double GrainLimitCoarse { get; set; }

public double GrainLimitCoarse { get; set; }

Public Property GrainLimitCoarse As Double 
	Get 
	Set

Public Property GrainLimitCoarse As Double 
	Get 
	Set

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

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

Property Value

Type: Double

Events

Event Type	Reason
CogPMAlignRunParams Changed	Fires when the value of this property changes. The following state flag may be affected: SfGrainLimitCoarse
CogPMAlignRunParams Changed	Fires when the value of this property changes and GrainLimitFine changes as well. The following state flags may be affected: SfGrainLimitCoarse SfGrainLimitFine

Event Type

Reason

CogPMAlignRunParams Changed

Fires when the value of this property changes.

The following state flag may be affected:

SfGrainLimitCoarse

CogPMAlignRunParams Changed

Fires when the value of this property changes and GrainLimitFine changes as well.

The following state flags may be affected:

Exceptions

Exception	Condition
ArgumentException	The supplied value is less than 1.0 or greater than 25.5.

Remarks

The coarse granularity limit that will be used at run-time if GrainLimitsUsePattern is false. GrainLimitCoarse must be greater than or equal to GrainLimitFine. Setting the coarse limit to a value less than the fine limit will also set the fine limit to the new coarse value. Valid range is from 1.0 through 25.5.

Default Value: 4.0