CogSearchMaxPattern.TrainRegion Property

CogSearchMaxPattern TrainRegion Property

Cognex VisionPro 9.8 SR1

Gets or sets the region of interest indicating portion of the TrainImage that will be used to train the pattern. A NULL TrainRegion indicates that the entire TrainImage will be used to train the CogSearchMaxPattern.

Namespace: Cognex.VisionPro.SearchMax
Assembly: Cognex.VisionPro.SearchMax (in Cognex.VisionPro.SearchMax.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
The region of interest indicating portion of the TrainImage. The default value is a default contstucted CogRectangleAffine that has been made interactive and has all DOFs enabled.

Events

Event Type	Reason
ICogChangedEvent Changed	Fires when this property changes. The following state flags may be affected: SfTrainRegion SfTrained SfGetTrainedPatternImage SfGetTrainedPatternImageMask

Event Type

Reason

ICogChangedEvent Changed

Fires when this property changes.

The following state flags may be affected:

SfTrainRegion
SfTrained
SfGetTrainedPatternImage
SfGetTrainedPatternImageMask

Exceptions

Exception	Condition
ObjectDisposedException	Thrown if this CogSearchMaxPattern object has already been disposed.

Remarks

Note Changing this property causes this CogSearchMaxPattern to become untrained.

Note This CogSearchMaxPattern will sink changed events for the region that you supply. Whenever the region changes, this CogSearchMaxPattern will become untrained.