Classes
| Class | Description | |
|---|---|---|
| CogPMAlignComposite | The PMAlign composite class. | |
| CogPMAlignCompositeDataItem | The PMAlign composite data item class. | |
| CogPMAlignCompositeDataItemCollection | The PMAlign composite data item collection. | |
| CogPMAlignMulti | The CogPMAlignMulti class. This class is a collection of CogPMAlignPatternItem objects and holds the training parameters. This class provides a method to train this object and a method to execute the inspection. The user can add patterns, access the patterns, and remove the patterns using the standard collection methods. For ease-of-use, adding and removing patterns will not un-train the tool; however, removing the last runnable pattern will un-train the tool. | |
| CogPMAlignMultiChangedEventArgs | Internal Cognex use only. | |
| CogPMAlignMultiResultItem | The PMAlignMultiResultItem class. This class holds the number of results found for a pattern. The execute method in CogPMAlignMulti will construct the object and will fill the content using internal setters. | |
| CogPMAlignMultiResultItemCollection | Result item collection. The CogPMAlignMultiResultItem collection is created when the multi-model is run. A CogPMAlignMultiResultItem object is added for each pattern located. This is a standard VisionPro collection, the regular collection methods and properties apply. See CogSerializableCollectionBase for more details. | |
| CogPMAlignMultiResults | The CogPMAlignMultiResults class. The class holds the results for the multi-model tool. The object is constructed at runtime. | |
| CogPMAlignMultiRunParams | The CogPMAlignMultiRunParams class. This class holds a CogPMAlignRunParams in addition to the mutli-model run parameters. | |
| CogPMAlignMultiTool | The multi-model tool locates multiple patterns in the runtime image. This tool encompasses all the classes required to run the inspection. This is the main class of the tool. It has the general tool methods and the tool specific properties. | |
| CogPMAlignPattern | Class which holds a single PMAlign pattern used for locating features within an image. Primary interface provides access to the training parameters, a method to train the pattern, results of training the pattern, and a method to execute an inspection. | |
| CogPMAlignPatternChangingEventArgs | Internal Cognex use only. | |
| CogPMAlignPatternItem | The PMAlign pattern item class.This class holds information to manage the CogPMAlignPattern object that is held by the operator such as a name, a flag to indicate if the object is in the queue and another flag to indicate that the object is runnable (multi-model trained). | |
| CogPMAlignResult | Class which holds a single PMAlign result. Each result corresponds to a found instance of the pattern. | |
| CogPMAlignResults | Class which holds a collection of PMAlign results. An instance of this class will be created and filled with individual results in order of decreasing score. | |
| CogPMAlignResultsShared | ||
| CogPMAlignRunParams | Class which holds PMAlign run parameters. The run parameters are used to control how PMAlign locates matching patterns in the run-time image. | |
| CogPMAlignTool | Tool which locates features using a PMAlign pattern. This tool encompasses all of the classes required to run a PMAlign inspection. | |
| CogPMAlignZoneAngle | Class which holds angle Degree Of Freedom (DOF) information. PMAlign can locate patterns that have changed in angle from the trained pattern. This class specifies the angle(s) at which patterns may be located. | |
| CogPMAlignZoneScale | Class which holds scale Degree Of Freedom (DOF) information. PMAlign can locate patterns that have changed in scale from the trained pattern. This class specifies the scale(s) at which patterns may be located. |
Interfaces
| Interface | Description | |
|---|---|---|
| ICogPMAlignFlexRunParams | Interface for PMAlign run parameters applying to the PatFlex algorithm. |
Delegates
| Delegate | Description | |
|---|---|---|
| CogPMAlignComposite InvalidatePMAlignCurrentRecord_Delegate | ||
| CogPMAlignMultiChangedEventHandler | ||
| CogPMAlignPatternChangingEventHandler | Internal Cognex use only. |
Enumerations
| Enumeration | Description | |
|---|---|---|
| CogPMAlignCurrentRecordConstants | Enumeration of data that can be provided in the Tool's CurrentRecord. | |
| CogPMAlignFlexDeformationFitConstants | Enumeration of fit types used to model deformation in the input image. | |
| CogPMAlignFlexDeformationInfoConstants | Enumeration of types of deformation info that can be saved. | |
| CogPMAlignFlexRefinementConstants | Enumeration of refinement levels for the PatFlex deformation transform. | |
| CogPMAlignLastRunRecordConstants | Enumeration of Non-Diagnostic data that can be provided in the Tool's LastRunRecord. | |
| CogPMAlignLastRunRecordDiagConstants | Enumeration of Diagnostic data that can be provided in the Tool's LastRunRecord. | |
| CogPMAlignMultiCurrentRecordConstants | Enumeration of data that can be provided in the Tool's CurrentRecord. | |
| CogPMAlignMultiLastRunRecordConstants | Enumeration of non-diagnostic data that can be provided in the Tool's LastRunRecord. | |
| CogPMAlignMultiLastRunRecordDiagConstants | Enumeration of diagnostic data that can be provided in the Tool's LastRunRecord. | |
| CogPMAlignMultiRuntimeModeConstants | Enumeration of runtime modes. The modes specify the search order for the patterns. | |
| CogPMAlignResultGraphicConstants | Constants used to specify desired result graphics. | |
| CogPMAlignRunAlgorithmConstants | Algorithm used to run the PMAlign pattern. | |
| CogPMAlignRunDiagnosticConstants | Diagnostic information about running PMAlign. | |
| CogPMAlignRunModeConstants | Mode used to run the PMAlign pattern. | |
| CogPMAlignTrainAlgorithmConstants | Algorithms for which the PMAlign pattern is to be trained. | |
| CogPMAlignTrainDiagnosticConstants | Diagnostic information about the training the pattern. | |
| CogPMAlignTrainModeConstants | Train mode constants are used to indicate whether a PMAlign pattern should be trained based on the pixel content of a training image or trained based on a synthetic pattern described by a collection of shape models. | |
| CogPMAlignVisiblePixelMaskScoringMethodConstants | Choices for how to treat non-visible pixels at run-time. | |
| CogPMAlignZoneConstants | Enumeration of configuration methods for a PMAlign DOF zone. |