Cog3DAlignTool.SearchRegion Property

Cog3DAlignTool SearchRegion Property

Cognex VisionPro

Gets or sets the search region. Only the portion of the 3D input that lies within this region will be searched by 3DAlign. If the supplied region object is null, the entire input image will be searched.

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

Syntax

C++

Copy to Clipboard Print

public ICog3DShape SearchRegion { get; set; }

public ICog3DShape SearchRegion { get; set; }

Public Property SearchRegion As ICog3DShape 
	Get 
	Set

Public Property SearchRegion As ICog3DShape 
	Get 
	Set

public:
property ICog3DShape^ SearchRegion {
	ICog3DShape^ get ();
	void set (ICog3DShape^ value);
}

public:
property ICog3DShape^ SearchRegion {
	ICog3DShape^ get ();
	void set (ICog3DShape^ value);
}

Property Value

Type: ICog3DShape
The search region. Default value is null.

Events

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

Remarks

You can use a search region to control what part of the input image is searched by the 3DAlign tool. The tool will only attempt to match the pattern to 3D data points that fall inside the 3D shape specified by the SearchRegion property. If this search region is null, the entire input image will be searched.

The only allowed shape for the search region is a Cog3DBox. The 3DAlign tool will completely ignore any 3D input points that fall outside of the specified box.