SegmentTool ClassCognex VisionPro 9.10

The segment tool partitions a run time image into one or more previously trained classes.

Inheritance Hierarchy

System Object
  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.10.0.0
Syntax

public sealed class SegmentTool : ToolBase, 
	IObject

The SegmentTool type exposes the following members.

Constructors

  NameDescription
Public methodSegmentTool

Construct a default instance of this class.

Top
Methods

  NameDescription
Public methodCheckRunConditionsSelf

Performs RunCondition check by the tool itself.

(Overrides ToolBase CheckRunConditionsSelf .)
Public methodCopyBase

Create a copy of this tool.

(Overrides ToolBase CopyBase(ToolCopyModeConstants).)
Public methodCreateCurrentRecord

Creates a new set of records that represents the tool's current state.

(Overrides ToolBase CreateCurrentRecord .)
Public methodCreateLastRunRecord

Creates a new set of records that represents the tool's last-run state.

(Overrides ToolBase CreateLastRunRecord .)
Public methodEquals
Compares the equality of this object with another.
(Overrides ToolBase Equals(Object).)
Public methodGenerateHeatmapGraphicForTrainDataItem

Create a heatmap graphic for the specified train data's image for the specified class.

Public methodGenerateHeatmapGraphicsForTrainDataItem

Create heatmap graphics for the specified train data's image for each of the classes.

Public methodGenerateSegmentGraphicForTrainDataItem

Create a segment graphic for the specified train data's image.

Public methodGetContainerAsILinkManager

Get the container which contains the Tool.

(Overrides ToolBase GetContainerAsILinkManager .)
Public methodGetHashCode
Returns the hash code of this object.
(Overrides ToolBase GetHashCode .)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetTypeMeta

Get the TypeMeta that describes the type of this object.

(Overrides ShareableBase GetTypeMeta .)
Public methodIsCheckRunConditionsDelegateToOwner

Check if tool checks its RunCondition by its owner.

(Overrides ToolBase IsCheckRunConditionsDelegateToOwner .)
Public methodResumeAndRaiseChangedEvent

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.

(Overrides ChangedEventShareableBase ResumeAndRaiseChangedEvent .)
Public methodRun

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.

(Overrides ToolBase Run .)
Public methodSuspendChangedEvent

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.

(Overrides ChangedEventShareableBase SuspendChangedEvent .)
Public methodToString

Returns a human readable string that represents the object.

(Overrides Object ToString .)
Top
Operators

  NameDescription
Public operatorStatic memberEquality
Compares the equality of two SegmentTool objects.
Public operatorStatic memberInequality
Compares the inequality of two SegmentTool objects.
Top
Fields

  NameDescription
Public fieldStatic memberSfAutoGrabCount
Public fieldStatic memberSfCurrentRecordEnable
Public fieldStatic memberSfInputImage
Public fieldStatic memberSfLastRunRecordDiagEnable
Public fieldStatic memberSfLastRunRecordEnable
Public fieldStatic memberSfPattern
Public fieldStatic memberSfRegion
Public fieldStatic memberSfResults
Public fieldStatic memberSfSelectedLabeledTrainData
Top
Properties

  NameDescription
Public propertyAutoGrabCount
Get

Gets the value of the AutoGrabCount. This value controls how many images can be auto grabbed in the ViDiELSegment Edit Control.

Public propertyChangedEventSuspended

Indicates if raising the ChangedEvent has been suspended.

(Overrides ChangedEventShareableBase ChangedEventSuspended.)
Public propertyCurrentRecordEnable
Get

Enable creation of records by bitwise ORing the appropriate SegmentCurrentRecordConstants. Options include None, InputImage, Region, and All.

Public propertyEnabled

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.

(Overrides ToolBase Enabled.)
Public propertyFailOnInvalidDataBinding

Whether the tool's Run method is to fail if executed while one or more DataBindings (aka Links) are Invalid.

(Overrides ToolBase FailOnInvalidDataBinding.)
Public propertyHandle (Overrides ToolBase Handle.)
Public propertyID

Gets the ID of the tracked item.

(Overrides TrackedItemBase ID.)
Public propertyInputImage
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.

Public propertyInputs

A collection of named Input Pin values.

(Overrides ToolBase Inputs.)
Public propertyLastRunRecordDiagEnable
Get

Enable creation of diagnostic records by bitwise ORing the appropriate SegmentLastRunRecordDiagConstants. Options include None, InputImageByReference, InputImageDeepCopy, Region, and All.

Public propertyLastRunRecordEnable
Get

Enable creation of non-diagnostic records by bitwise ORing the appropriate SegmentLastRunRecordConstants. Options include None, Heatmaps, HeatmapsAsGraphics, SegmentGraphic, and All.

Public propertyName

Get the name of the tracked item.

(Overrides TrackedItemBase Name.)
Public propertyOutputs

A collection of named Output Pin values.

(Overrides ToolBase Outputs.)
Public propertyParent

Return a reference to the containing tracking collection. May be null.

(Overrides TrackedItemBase Parent.)
Public propertyPattern
Get

Get the pattern for this segment tool.

Public propertyRegion
Get

Specifies the region of the InputImage that will be used to perform segmentation.

Public propertyResults

The results from the last invocation of the Run method. A new instance of SegmentResults is created for each run.

Public propertyRunStatus

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.

(Overrides ToolBase RunStatus.)
Public propertySelectedLabeledTrainData
Get

Gets the currently selected TrainData from the Database that has IsTraining set to true.

Top
Events

  NameDescription
Public eventChanged

The actual event.

(Overrides ChangedEventShareableBase Changed.)
Public eventNameChanging

This event is raised when the Name is about to change. Note that this is a cancellable event.

(Overrides TrackedItemBase NameChanging.)
Public eventRan

Event that is raised at the end of the tool's Run method.

(Overrides ToolBase Ran.)
Public eventRunning

Event that is raised at the start of the tool's Run method.

(Overrides ToolBase Running.)
Top
See Also