CogPMAlignPattern.GetTrainedPatternImage Method

CogPMAlignPattern GetTrainedPatternImage Method

Cognex VisionPro 9.22 SR1

Gets the image used to train the PMAlign pattern. This is the smallest possible sub-image of TrainImage that contains the TrainRegion. Actual features within the sub-image that are trained depends on the TrainRegionMode and TrainImageMask.

Namespace: Cognex.VisionPro.PMAlign
Assembly: Cognex.VisionPro.PMAlign (in Cognex.VisionPro.PMAlign.dll) Version: 87.1.0.0

Syntax

C++

Copy to Clipboard Print

public ICogImage GetTrainedPatternImage()

public ICogImage GetTrainedPatternImage()

Public Function GetTrainedPatternImage As ICogImage

Public Function GetTrainedPatternImage As ICogImage

public:
ICogImage^ GetTrainedPatternImage()

public:
ICogImage^ GetTrainedPatternImage()

Return Value

Type: ICogImage

Exceptions

Exception	Condition
CogOperatorNotTrainedException	This pattern is not trained.
CogPMAlignWrongTrainModeException	TrainMode is ShapeModelsWithTransform.

Remarks

Gets an ICogImage containing the region of the TrainImage that was used to train PMAlign. This image may contain a larger portion of the TrainImage than just the TrainRegion depending on the TrainRegionMode.

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()
  CogDisplay1.Image = myPattern.GetTrainedPatternImage

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()
  CogDisplay1.Image = myPattern.GetTrainedPatternImage

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();
  CogDisplay1.Image = myPattern.GetTrainedPatternImage();
}

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();
  CogDisplay1.Image = myPattern.GetTrainedPatternImage();
}