CogCNLSearchPattern.TrainRegion Property

CogCNLSearchPattern TrainRegion Property

Cognex VisionPro 9.8 SR1

Region of interest in the TrainImage that will be used to train the pattern. A NULL TrainRegion indicates that the entire TrainImage will be used to train the CNLSearch pattern.

Namespace: Cognex.VisionPro.CNLSearch
Assembly: Cognex.VisionPro.CNLSearch (in Cognex.VisionPro.CNLSearch.dll) Version: 75.0.0.0

Syntax

C++

Copy to Clipboard Print

public ICogRegion TrainRegion { get; set; }

public ICogRegion TrainRegion { get; set; }

Public Property TrainRegion As ICogRegion 
	Get 
	Set

Public Property TrainRegion As ICogRegion 
	Get 
	Set

public:
property ICogRegion^ TrainRegion {
	ICogRegion^ get ();
	void set (ICogRegion^ value);
}

public:
property ICogRegion^ TrainRegion {
	ICogRegion^ get ();
	void set (ICogRegion^ value);
}

Property Value

Type: ICogRegion

Events

Event Type	Reason
CogCNLSearchPattern Changed	Fires when the TrainRegion is changed, but the change does cause the pattern to become untrained (because it has not been trained yet). The following state flag may be affected: SfTrainRegion
CogCNLSearchPattern Changed	Fires when the TrainRegion is changed and this pattern becomes untrained. The following state flag may be affected: SfTrainRegion

Event Type

Reason

CogCNLSearchPattern Changed

Fires when the TrainRegion is changed, but the change does cause the pattern to become untrained (because it has not been trained yet).

The following state flag may be affected:

SfTrainRegion

CogCNLSearchPattern Changed

Fires when the TrainRegion is changed and this pattern becomes untrained.

The following state flag may be affected:

SfTrainRegion

Remarks

Region of interest in the TrainImage that will be used to train the pattern. A NULL TrainRegion indicates that the entire TrainImage will be used to train the CNLSearch pattern.

You can specify any type of region and you can enable any degrees of freedom in the region. Use the TrainRegionMode property to control how the input region is used.

Default Value: An interactive, default-constructed CogRectangle with all degrees of freedom enabled.