CogPMAlignPattern.TrainRegionMode Property

CogPMAlignPattern TrainRegionMode Property

Cognex VisionPro 9.5

Specifies how the TrainRegion is applied to the TrainImage.

Namespace: Cognex.VisionPro.PMAlign
Assembly: Cognex.VisionPro.PMAlign (in Cognex.VisionPro.PMAlign.dll) Version: 69.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

Events

Event Type	Reason
CogPMAlignPattern Changed	Fires when the value of this property changes. The following state flag may be affected: SfTrainRegionMode
CogPMAlignPattern Changed	Fires when the value of this property changes and the pattern was untrained. The following state flags may be affected: SfTrainRegion SfTrainRegionMode SfGetInfoIDs SfTrained SfCreateGraphicsCoarse SfCreateGraphicsFine SfGetInfoStrings SfGetTrainedPatternImage SfGetTrainedPatternImageMask SfGetTrainedPatternShapeModels

Event Type

Reason

CogPMAlignPattern Changed

Fires when the value of this property changes.

The following state flag may be affected:

SfTrainRegionMode

CogPMAlignPattern Changed

Fires when the value of this property changes and the pattern was untrained.

The following state flags may be affected:

Exceptions

Exception	Condition
ArgumentException	The supplied value is neither PixelAlignedBoundingBox nor PixelAlignedBoundingBoxAdjustMask.

Remarks

Specifies how the TrainRegion is applied to the TrainImage. The value of this property must be one of the values specified in CogRegionModeConstants.

Note: Changing this property causes this CogPMAlignPattern to become untrained.

Default Value: PixelAlignedBoundingBoxAdjustMask

Examples

Copy to Clipboard Print

Imports Cognex.VisionPro
Imports Cognex.VisionPro.PMAlign

Private myPattern As New CogPMAlignPattern
Private myParams As New CogPMAlignRunParams
Private myResults As CogPMAlignResults

Private Sub doTrain()


  myPattern.TrainAlgorithm = CogPMAlignTrainAlgorithmConstants.PatMaxAndPatQuick
  myPattern.TrainMode = CogPMAlignTrainModeConstants.Image

  myPattern.TrainImage = anImage
  myPattern.TrainRegion = trainRect
  myPattern.TrainRegionMode = CogRegionModeConstants.PixelAlignedBoundingBox
  myPattern.Origin.TranslationX = trainRect.CenterX
  myPattern.Origin.TranslationY = trainRect.CenterY



  myPattern.Train()
end sub

Imports Cognex.VisionPro
Imports Cognex.VisionPro.PMAlign

Private myPattern As New CogPMAlignPattern
Private myParams As New CogPMAlignRunParams
Private myResults As CogPMAlignResults

Private Sub doTrain()


  myPattern.TrainAlgorithm = CogPMAlignTrainAlgorithmConstants.PatMaxAndPatQuick
  myPattern.TrainMode = CogPMAlignTrainModeConstants.Image

  myPattern.TrainImage = anImage
  myPattern.TrainRegion = trainRect
  myPattern.TrainRegionMode = CogRegionModeConstants.PixelAlignedBoundingBox
  myPattern.Origin.TranslationX = trainRect.CenterX
  myPattern.Origin.TranslationY = trainRect.CenterY



  myPattern.Train()
end sub

C++

Copy to Clipboard Print

using Cognex.VisionPro;
using Cognex.VisionPro.PMAlign;

private CogPMAlignPattern myPattern = new CogPMAlignPattern();
private CogPMAlignRunParams myParams =new CogPMAlignRunParams();
private CogPMAlignResults myResults;

private void doTrain()
{

  myPattern.TrainAlgorithm = CogPMAlignTrainAlgorithmConstants.PatMaxAndPatQuick;
  myPattern.TrainMode = CogPMAlignTrainModeConstants.Image;


  myPattern.TrainImage = anImage;
  myPattern.TrainRegion = trainRect;
  myPattern.TrainRegionMode = CogRegionModeConstants.PixelAlignedBoundingBox;
  myPattern.Origin.TranslationX = trainRect.CenterX;
  myPattern.Origin.TranslationY = trainRect.CenterY;


  myPattern.Train();
}

using Cognex.VisionPro;
using Cognex.VisionPro.PMAlign;

private CogPMAlignPattern myPattern = new CogPMAlignPattern();
private CogPMAlignRunParams myParams =new CogPMAlignRunParams();
private CogPMAlignResults myResults;

private void doTrain()
{

  myPattern.TrainAlgorithm = CogPMAlignTrainAlgorithmConstants.PatMaxAndPatQuick;
  myPattern.TrainMode = CogPMAlignTrainModeConstants.Image;


  myPattern.TrainImage = anImage;
  myPattern.TrainRegion = trainRect;
  myPattern.TrainRegionMode = CogRegionModeConstants.PixelAlignedBoundingBox;
  myPattern.Origin.TranslationX = trainRect.CenterX;
  myPattern.Origin.TranslationY = trainRect.CenterY;


  myPattern.Train();
}