CogSurfaceFX.SpaceTreeMode Property

CogSurfaceFX SpaceTreeMode Property

Cognex VisionPro

Gets or sets the SpaceTreeMode. Allows the user to choose which coordinate space tree to copy to the output image, or choose to merge the coordinate spaces from the all of the input images.

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

Syntax

C++

Copy to Clipboard Print

public CogSurfaceFXSpaceTreeModeConstants SpaceTreeMode { get; set; }

public CogSurfaceFXSpaceTreeModeConstants SpaceTreeMode { get; set; }

Public Property SpaceTreeMode As CogSurfaceFXSpaceTreeModeConstants 
	Get 
	Set

Public Property SpaceTreeMode As CogSurfaceFXSpaceTreeModeConstants 
	Get 
	Set

public:
property CogSurfaceFXSpaceTreeModeConstants SpaceTreeMode {
	CogSurfaceFXSpaceTreeModeConstants get ();
	void set (CogSurfaceFXSpaceTreeModeConstants value);
}

public:
property CogSurfaceFXSpaceTreeModeConstants SpaceTreeMode {
	CogSurfaceFXSpaceTreeModeConstants get ();
	void set (CogSurfaceFXSpaceTreeModeConstants value);
}

Property Value

Type: CogSurfaceFXSpaceTreeModeConstants
The default value is CopyLitFromRight, the first image in the vision data container.

Events

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

Exceptions

Exception	Condition
ArgumentOutOfRangeException	The supplied value is none of the specified enumeration values.
ObjectDisposedException	If the object has been disposed.

Remarks

There are 2 different way of creating the coordinate space tree in the output image :

You can choose to Copy the coordinate space tree from one of the input images. In this case, the tree of the chosen input image is copied by reference to output image.The input and output images both refer to that one tree.The coordinate spaces from all the other input images do not appear in the output.
You can choose to Merge together the coordinate space trees from all of the input images.This choice preserves all of the input coordinate spaces, but results in a more complicated tree structure.The tree of the output image has four main branches -- one for each of the input images.The first coordinate space on each branch is named using the corresponding key string from the input CogVisionDataContainer. The second coordinate space on each branch is a reference to the entire coordinate space tree of the matching input image. You can use this enlarged tree to map between any of the input coordinate spaces.