Cog3DAlignRunParams.NumberToFind Property

Cog3DAlignRunParams NumberToFind Property

Cognex VisionPro

Gets or sets the number of results to search for.

Namespace: Cognex.VisionPro3D
Assembly: Cognex.VisionPro3D (in Cognex.VisionPro3D.dll) Version: 65.1.0.0

Syntax

public int NumberToFind { get; set; }

public int NumberToFind { get; set; }

Public Property NumberToFind As Integer 
	Get 
	Set

Public Property NumberToFind As Integer 
	Get 
	Set

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

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

Property Value

Type: Int32
The number of results to search for. Default value is 1.

Events

Event Type	Reason
ICogChangedEvent Changed	Fires when this property changes. The following state flag may be affected: SfNumberToFind

Exceptions

Exception	Condition
ArgumentOutOfRangeException	The supplied value is less than one.

Remarks

You should set this value to the maximum number of pattern instances that you ever expect to find in your input image. The number of results returned by 3DAlign will always be less than or equal to the value you specify.

A Cog3DAlignResult is returned only if all of the following conditions are met:

Its Score is greater than or equal to AcceptThreshold.
Its position satisfies the LocationConstraintMode that you specified.
Its rotation (as reported by the Rotation property of the Cog3DTransformRigid returned by GetPose ) falls within the angle zone ranges you specified using ZoneAngleFirst, ZoneAngleSecond and ZoneAngleThird with your chosen ZoneAngleDecomposition mode.
Its Score makes it one of the top-scoring results. Only the NumberToFind top-scoring results (that meet all of the other conditions) will be returned.