SegmentTool PropertiesCognex VisionPro 9.21 SR1

The SegmentTool type exposes the following members.

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
See Also