Gets the actual mask image used to train the current pattern. This mask is the combination of the TrainImageMask and any mask that may be required by TrainRegionMode. This mask is the same size as the image returned by GetTrainedPatternImage.
Namespace: Cognex.VisionPro.PMAlignAssembly: Cognex.VisionPro.PMAlign (in Cognex.VisionPro.PMAlign.dll) Version: 93.1.0.0
Syntax
Return Value
Type: CogImage8GreyExceptions
| Exception | Condition |
|---|---|
| CogOperatorNotTrainedException | This pattern is not trained. |
| CogPMAlignWrongTrainModeException | TrainMode is ShapeModelsWithTransform or ShapeModelsWithImage. |
Remarks
Image containing masking information required to apply the TrainRegion to the TrainImage based on the TrainRegionMode. This mask image will also contain masking information from the TrainImageMask provided by the user.
See Also