Cog3DPatMaxRunParams.RunMode Property

Cog3DPatMaxRunParams RunMode Property

Cognex VisionPro 9.8

Gets or sets the run mode. This mode controls how the tool should search for matches in the runtime 3D data.

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

Syntax

public Cog3DPatMaxRunModeConstants RunMode { get; set; }

public Cog3DPatMaxRunModeConstants RunMode { get; set; }

Public Property RunMode As Cog3DPatMaxRunModeConstants 
	Get 
	Set

Public Property RunMode As Cog3DPatMaxRunModeConstants 
	Get 
	Set

public:
property Cog3DPatMaxRunModeConstants RunMode {
	Cog3DPatMaxRunModeConstants get ();
	void set (Cog3DPatMaxRunModeConstants value);
}

public:
property Cog3DPatMaxRunModeConstants RunMode {
	Cog3DPatMaxRunModeConstants get ();
	void set (Cog3DPatMaxRunModeConstants value);
}

Property Value

Type: Cog3DPatMaxRunModeConstants
The run mode. Default value is SearchImage.

Events

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

Exceptions

Exception	Condition
ArgumentOutOfRangeException	The supplied value is not a member of Cog3DPatMaxRunModeConstants.

Remarks

In the most common usage, the user would specify SearchImage to let the tool search the run-time 3D data for matches. In this usage, the tool does not require any approximate input pose for potential matches, and will simply search for them in the run-time 3D data.

In the event that the user already knows the presence of an instance as well as its approximate run-time pose, it may be appropriate to use RefineStartPose to improve the pose accuracy at a faster run-time speed.