The segment tool partitions a run time image into one or more previously trained classes.
Cognex.Vision ShareableBase
Cognex.Vision ChangedEventShareableBase
Cognex.Vision.Implementation TrackedItemBase
Cognex.Vision.Implementation ToolBase
Cognex.Vision.ViDiEL SegmentTool
Namespace: Cognex.Vision.ViDiEL
Assembly: Cognex.Vision.ViDiELSegment.Net (in Cognex.Vision.ViDiELSegment.Net.dll) Version: 9.25.1.0
The SegmentTool type exposes the following members.
| Name | Description | |
|---|---|---|
| SegmentTool | Construct a default instance of this class. |
| Name | Description | |
|---|---|---|
| CheckRunConditionsSelf | Performs RunCondition check by the tool itself. | |
| CopyBase | Create a copy of this tool. | |
| CreateCurrentRecord | Creates a new set of records that represents the tool's current state. | |
| CreateLastRunRecord | Creates a new set of records that represents the tool's last-run state. | |
| Equals | Compares the equality of this object with another. (Overrides ToolBase Equals(Object).) | |
| GenerateHeatmapGraphicForTrainDataItem | Create a heatmap graphic for the specified train data's image for the specified class. | |
| GenerateHeatmapGraphicsForTrainDataItem | Create heatmap graphics for the specified train data's image for each of the classes. | |
| GenerateSegmentGraphicForTrainDataItem | Create a segment graphic for the specified train data's image. | |
| GetContainerAsILinkManager | Get the container which contains the Tool. | |
| GetHashCode | Returns the hash code of this object. (Overrides ToolBase GetHashCode .) | |
| GetType | Gets the Type of the current instance. (Inherited from Object.) | |
| GetTypeMeta | Get the TypeMeta that describes the type of this object. | |
| IsCheckRunConditionsDelegateToOwner | Check if tool checks its RunCondition by its owner. | |
| ResumeAndRaiseChangedEvent | Re-enables raising of the ChangedEvent after SuspendChangedEvent has been called, and raises the ChangedEvent if the ChangedEventSuspended count is reduced to zero and any changes were made while events were suspended. Must be called once for each call to SuspendChangedEvent. | |
| Run | Runs the tool. This method is guaranteed to not throw an exception. Any exception generated in the course of running the tool will be caught and a string representation of that exception will be packaged in the Message property of the tool's RunStatus. Should this occur, the Result property of the tool's RunStatus will be set to Error. It is the user's responsibility to examine the tool's RunStatus after calling Run. | |
| SuspendChangedEvent | Temporarily suspends the raising of the ChangedEvent. May be called more than once, and a corresponding call to ResumeAndRaiseChangedEvent must be made for each call to SuspendChangedEvent. | |
| ToString | Returns a human readable string that represents the object. |
| Name | Description | |
|---|---|---|
| Equality | Compares the equality of two SegmentTool objects. | |
| Inequality | Compares the inequality of two SegmentTool objects. |
| Name | Description | |
|---|---|---|
| SfAutoGrabCount | ||
| SfCurrentRecordEnable | ||
| SfInputImage | ||
| SfLastRunRecordDiagEnable | ||
| SfLastRunRecordEnable | ||
| SfPattern | ||
| SfRegion | ||
| SfResults | ||
| SfSelectedLabeledTrainData |
| Name | Description | |
|---|---|---|
| AutoGrabCount | Get Gets the value of the AutoGrabCount. This value controls how many images can be auto grabbed in the ViDiELSegment Edit Control. | |
| ChangedEventSuspended | Indicates if raising the ChangedEvent has been suspended. | |
| CurrentRecordEnable | Get Enable creation of records by bitwise ORing the appropriate SegmentCurrentRecordConstants. Options include None, InputImage, Region, and All. | |
| Enabled | Whether the tool is enabled to run. If false, calling the tool's Run function will not actually run the tool and will cause no change in the tool's state. | |
| FailOnInvalidDataBinding | Whether the tool's Run method is to fail if executed while one or more DataBindings (aka Links) are Invalid. | |
| Handle | (Overrides ToolBase Handle.) | |
| ID | Gets the ID of the tracked item. | |
| InputImage | Get The image used to perform segmentation. The Region property can be used to specify that segmentation only be performed on a portion of the InputImage. Segmentation is performed on the entire InputImage if Region is null. | |
| Inputs | A collection of named Input Pin values. | |
| LastRunRecordDiagEnable | Get Enable creation of diagnostic records by bitwise ORing the appropriate SegmentLastRunRecordDiagConstants. Options include None, InputImageByReference, InputImageDeepCopy, Region, and All. | |
| LastRunRecordEnable | Get Enable creation of non-diagnostic records by bitwise ORing the appropriate SegmentLastRunRecordConstants. Options include None, Heatmaps, HeatmapsAsGraphics, SegmentGraphic, and All. | |
| Name | Get the name of the tracked item. | |
| Outputs | A collection of named Output Pin values. | |
| Parent | Return a reference to the containing tracking collection. May be null. | |
| Pattern | Get Get the pattern for this segment tool. | |
| Region | Get Specifies the region of the InputImage that will be used to perform segmentation. | |
| Results | The results from the last invocation of the Run method. A new instance of SegmentResults is created for each run. | |
| RunStatus | Gets general information about the last call to the tool's Run method. Note that serious errors that occur within the tool's Run method may only be detected by examining the RunStatus after calling Run. It is the user's responsibility to examine the tool's RunStatus after calling Run. | |
| SelectedLabeledTrainData | Get Gets the currently selected TrainData from the Database that has IsTraining set to true. |
| Name | Description | |
|---|---|---|
| Changed | The actual event. | |
| NameChanging | This event is raised when the Name is about to change. Note that this is a cancellable event. | |
| Ran | Event that is raised at the end of the tool's Run method. | |
| Running | Event that is raised at the start of the tool's Run method. |