CogPMAlignPattern.GrainLimitCoarse Property

CogPMAlignPattern GrainLimitCoarse Property

Cognex VisionPro 9.5

Coarse granularity limit. User can manually set the grain limit if GrainLimitAutoSelect is false. Valid range is 1.0 to 25.5 inclusive. Coarse must be greater than or equal to fine. Setting coarse less than fine will also set fine to the new value.

Namespace: Cognex.VisionPro.PMAlign
Assembly: Cognex.VisionPro.PMAlign (in Cognex.VisionPro.PMAlign.dll) Version: 69.0.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
CogPMAlignPattern Changed	Fires when the value of this property changes. The following state flag may be affected: SfGrainLimitCoarse
CogPMAlignPattern Changed	Fires when the value of this property changes. The new value was less than GrainLimitFine so it was set to the new value. The following state flags may be affected:
CogPMAlignPattern Changed	Fires when the value of this property changes and the pattern was untrained. The new value may also have been less than GrainLimitFine, in which case its value was set to the new value. The following state flags may be affected: SfGrainLimitAutoSelect SfGrainLimitCoarse SfGrainLimitFine SfGetInfoIDs SfTrained SfCreateGraphicsCoarse SfCreateGraphicsFine SfGetInfoStrings SfGetTrainedPatternImage SfGetTrainedPatternImageMask SfGetTrainedPatternShapeModels

Event Type

Reason

CogPMAlignPattern Changed

Fires when the value of this property changes.

The following state flag may be affected:

SfGrainLimitCoarse

CogPMAlignPattern Changed

Fires when the value of this property changes. The new value was less than GrainLimitFine so it was set to the new value.

The following state flags may be affected:

CogPMAlignPattern Changed

Fires when the value of this property changes and the pattern was untrained. The new value may also have been less than GrainLimitFine, in which case its value was set to the new value.

The following state flags may be affected:

Exceptions

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

Remarks

Coarse granularity limit. You can manually set the grain limit if GrainLimitAutoSelect is False. The valid range is from 1.0 to 25.5.

The coarse and fine granularity limits represent the largest and smallest feature sizes that PatMax uses to locate patterns in a run-time image. PatMax uses a range of granularity values within the range you specify.

GrainLimitCoarse must be greater than or equal to GrainLimitFine. Setting GrainLimitCoarse less than GrainLimitFine sets GrainLimitFine to the new GrainLimitCoarse value.

Note: Changing this property causes this CogPMAlignPattern to become untrained.

Default Value: 4.0