CogSearchMaxPattern.TrainRegionMode Property

CogSearchMaxPattern TrainRegionMode Property

Cognex VisionPro 9.24

Gets or sets the region mode which specifies how the TrainRegion is applied to the TrainImage.

Namespace: Cognex.VisionPro.SearchMax
Assembly: Cognex.VisionPro.SearchMax (in Cognex.VisionPro.SearchMax.dll) Version: 91.0.0.0

Syntax

C++

Copy to Clipboard Print

public CogRegionModeConstants TrainRegionMode { get; set; }

public CogRegionModeConstants TrainRegionMode { get; set; }

Public Property TrainRegionMode As CogRegionModeConstants 
	Get 
	Set

Public Property TrainRegionMode As CogRegionModeConstants 
	Get 
	Set

public:
property CogRegionModeConstants TrainRegionMode {
	CogRegionModeConstants get ();
	void set (CogRegionModeConstants value);
}

public:
property CogRegionModeConstants TrainRegionMode {
	CogRegionModeConstants get ();
	void set (CogRegionModeConstants value);
}

Property Value

Type: CogRegionModeConstants
The region mode which may be either PixelAlignedBoundingBox or PixelAlignedBoundingBoxAdjustMask. Default values is PixelAlignedBoundingBoxAdjustMask.

Events

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

Event Type

Reason

ICogChangedEvent Changed

Fires when this property changes.

The following state flags may be affected:

SfTrainRegionMode
SfTrained
SfGetTrainedPatternImage
SfGetTrainedPatternImageMask

Exceptions

Exception	Condition
ArgumentOutOfRangeException	Thrown if you attempt to set this to a value other than PixelAlignedBounding or PixelAlignedBoundingBoxAdjustMask.
ObjectDisposedException	Thrown if this CogSearchMaxPattern object has already been disposed.

Remarks

Note Changing this property causes this CogSearchMaxPattern to become untrained.