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.CNLSearchAssembly: Cognex.VisionPro.CNLSearch (in Cognex.VisionPro.CNLSearch.dll) Version: 93.1.0.0
Syntax
Return Value
Type: CogImage8GreyThe mask image. NULL is returned if this pattern is not trained for the Linear Search algorithm (the only algorithm that supports the use of a mask.
Exceptions
| Exception | Condition |
|---|---|
| CogOperatorNotTrainedException | This pattern is not trained. |
Remarks
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 .
See Also