Distance Line Ellipse Edit ControlCognex VisionPro

This topic contains the following sections.

The Distance Line Ellipse edit control provides a graphical user interface to the DistanceLineEllipse method, which returns the shortest distance between Line to Ellipse. The edit control allows you to configure the line and the ellipse, dictate which graphics appear as the tool executes, and view tool results. The following figure shows the Distance Line Ellipse edit control:

Cognex Dimensioning Distance Line Ellipse Control Distance Line Ellipse Whole Control

The edit control offers the following features:

  • A row of control buttons at the top left
  • A set of function tabs to define the line and the ellipse, choose what graphics the tool will use, and view results
  • An image display window for displaying tool images and graphics

You can experiment with the edit control by using QuickBuild to create a CogDistanceLineEllipse tool. A new CogDistanceLineEllipse tool appears as shown in the following figure:

Cognex Dimensioning Distance Line Ellipse Control Distance Line Ellipse Terminals

The line and ellipse parameters can either be specified directly from within the edit control or accepted as the result of other shape-generating vision tools. For example, the following figure shows how a Distance Line Ellipse tool accepts the Line and Ellipse generated as output from a Create Line and Create Ellipse tools:

Cognex Dimensioning Distance Line Ellipse Control Distance Line Ellipse Accept Shapes

To include the edit control in your custom vision application, you must first add it to your Visual Studio.NET development environment. See Using Edit Controls in Your Custom Vision Applications for more information.

Control Buttons

Cognex Dimensioning Distance Line Ellipse Control MTWButton Bar

The following table describes the function of each button:

Table 1. Control buttons
ButtonDescriptionFunction
Run Button
RunMeasures the distance between the line and ellipse
Electric Button
Electric modeToggles electric mode, where the Distance Line Ellipse tool executes automatically when particular configuration parameters change. In electric mode, a lightning bolt appears next to every electric property

Local Display Button

Local image display

Opens or closes the local image display window. A Distance Line Ellipse tool supports the following image buffers:

  • The Current.InputImage buffer contains the current image and the input line and input ellipse
  • The LastRun.InputImage buffer contains the results of the tool after it measures the distance between the line and the ellipse
Floating Display Button
Floating image displayOpens one or more floating image windows, which support the same image buffers as the local image display window
Open Button
OpenOpens a VisionPro persistence (.vpp) file that contains a set of saved properties for this vision tool type. VisionPro reports an error if you try to open a .vpp file for another object type.
Save Button
SaveSaves the current properties of the vision tool to a VisionPro persistence (.vpp) file. The edit control allows you to choose between saving the vision tool with or without its image buffers and tool results.
Save As Button
Save AsSaves the current properties of the vision tool to a new VisionPro persistence (.vpp) file
Reset Button
ResetResets the vision tool to its default state.
Tool Tips Button
Show ToolTipsEnables or disables the display of tooltips for individual items in the edit control
Help Button
HelpOpens this VisionPro online help file
Settings Tab

Use the Settings tab to define Line and Ellipse, or use the tab to confirm that the existing shapes correspond to the correct input parameters generated by another tool. The following figure shows the Settings tab:

Cognex Dimensioning Distance Line Ellipse Control Distance Line Ellipse Settings Tab

The Settings tab offers the following features to define the Line parameter:

Table 2. Settings tab
FeatureDescription
SelectedSpaceNameNames the coordinate space for the line shape
XThe x-coordinate of a reference point on the line
YThe y-coordinate of a reference point on the line
RotationThe angle of the line
FitToImageCenters the line within the Current.InputImage

The Settings tab offers the following features to define the Ellipse parameter:

Table 3. Settings tab
FeatureDescription
SelectedSpaceNameNames the coordinate space for the ellipse shape
CenterXThe x-coordinate at the center of the ellipse
CenterYThe y-coordinate at the center of the ellipse
RadiusXThe distance from the center of the ellipse to its boundary along the x-axis.
RadiusYThe distance from the center of the ellipse to its boundary along the y-axis.
FitToImageCenters the ellipse within the Current.InputImage
Graphics Tab

Use the Graphics tab to control which graphics the Distance Line Ellipse tool generates and displays. The following figure shows the Graphics tab:

Cognex Dimensioning Distance Line Ellipse Control Distance Line Ellipse Graphics Tab

The Graphics tab offers the following features:

Table 4. Graphics tab
FeatureDescription
Show Input ImageDetermines whether or not the input image is recorded as part of the diagnostic record, and whether the image is copied to the record or saved in the record as a reference
Show LineShow Line in the LastRun.InputImage buffer
Show EllipseShow Ellipse in the LastRun.InputImage buffer
Show ArrowShow the line segment representing the shortest distance between Line and Ellipse
Results Tab

Use the Results tab to view the relationship between Line and Ellipse as determined by the Distance Line Ellipse tool. The following figure shows the Results tab:

Cognex Dimensioning Distance Line Ellipse Control Distance Line Ellipse Results Tab

The Results tab offers the following features:

Table 5. Results tab
FeatureDescription
DistanceThe shortest distance between Line and Ellipse
LineX and LineYThe (x, y) coordinate on Line that is closest to Ellipse
EllipseX and EllipseYThe (x, y) coordinate on Ellipse that is closest to Line