CogSearchMaxPattern.GrainLimitCoarse Property

CogSearchMaxPattern GrainLimitCoarse Property

Cognex VisionPro 9.22 SR1

Gets or sets the coarse granularity limit. User can manually set the grain limits, but if GrainLimitAutoSelect is true, they will be overwritten by the automatically generated granularity limits. 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.SearchMax
Assembly: Cognex.VisionPro.SearchMax (in Cognex.VisionPro.SearchMax.dll) Version: 87.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
The coarse granularity limit. Valid range is 1.0 to 25.5 inclusive, and default value is 4.0.

Events

Event Type	Reason
ICogChangedEvent Changed	Fires when this property changes. The following state flags may be affected: SfGrainLimitCoarse SfGrainLimitFine SfTrained SfGetTrainedPatternImage SfGetTrainedPatternImageMask

Event Type

Reason

ICogChangedEvent Changed

Fires when this property changes.

The following state flags may be affected:

SfGrainLimitCoarse
SfGrainLimitFine
SfTrained
SfGetTrainedPatternImage
SfGetTrainedPatternImageMask

Exceptions

Exception	Condition
ArgumentOutOfRangeException	Thrown when you attempt to set this to a value less than 1.0 or greater than 25.5.
ObjectDisposedException	Thrown if this CogSearchMaxPattern object has already been disposed.

Remarks

The coarse and fine granularity limits represent the largest and smallest feature sizes that SearchMax uses to locate patterns in a run-time image. SearchMax 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 CogSearchMaxPattern to become untrained.