Create Segment By Averaging Edit Control

Cognex VisionPro

This topic contains the following sections.

Control Buttons
Settings Tab
Graphics Tab
Results Tab

The Create Segment By Averaging edit control provides a graphical user interface to the CreateSegmentByAveragingSegments method, which creates a new line segment by averaging SegmentA and SegmentB. The edit control allows you to configure the two line segments, dictate which graphics appear as the tool executes, and view tool results. The following figure shows the Create Segment By Averaging edit control:

Cognex Dimensioning Create Segment Avg Segs Control Create Segment By Averaging Segments Whole Control

The edit control offers the following features:

A row of control buttons at the top left
A set of function tabs to configure the two line segments, 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 CogCreateSegmentAvgSegs tool. A new CogCreateSegmentAvgSegs tool appears as shown in the following figure:

Cognex Dimensioning Create Segment Avg Segs Control Create Segment By Averaging Terminals

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 Create Segment Avg Segs Control MTWButton Bar

The following table describes the function of each button:

Table 1. Control buttons

Button	Description	Function
	Run	Creates a new line segment by averaging the two input line segments
	Electric mode	Toggles electric mode, where the Create Segment By Averaging tool executes automatically when particular configuration parameters change. In electric mode, a lightning bolt appears next to every electric property
	Local image display	Opens or closes the local image display window. A Create Segment By Averaging tool supports the following image buffers: The Current.InputImage buffer contains the current image and the input line segments The LastRun.InputImage buffer contains the results of the tool after it creates a new line segment
	Floating image display	Opens one or more floating image windows, which support the same image buffers as the local image display window
	Open	Opens a VisionPro persistence (.vpp) file that contains a set of saved properties for this vision tool object type. VisionPro reports an error if you try to open a .vpp file for another object type.
	Save	Saves 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	Saves the current properties of the vision tool to a new VisionPro persistence (.vpp) file
	Reset	Resets the vision tool to its default state.
	Show ToolTips	Enables or disables the display of tooltips for individual items in the edit control
	Help	Opens this VisionPro online help file

Settings Tab

Use the Settings tab to define the input line segments. The following figure shows the Settings tab:

The Settings tab offers identical features for defining both SegmentA and SegmentB parameters:

Table 2. Settings tab

Feature	Description
SelectedSpaceName	Names the coordinate space for the segment shape
Select Mode	Determines whether the line segment is determined by the 2 Points option (two [x, y] coordinates) or by the Point/Length option (a starting [x, y] coordinate followed by a line length and a measure of rotation).
StartX and StartY	Names the starting (x, y) coordinate of the line segment
EndX and EndY	Names the ending (x, y) coordinate of the line segment when using the 2 Points option.
Length and Rotation	Controls the length and angle of rotation of the line segment when using the Point/Length option.
FitToImage	Centers the line segment within the Current.InputImage

With the Output drawing style section, you can control the appearance of the output shape that is drawn on the image. See the controls and the example below.

Table 3. Settings tab

Feature	Description
OutputColor	The output shape color
OutputLineWidthInScreenPixels	The line width of the output shape
OutputLineStyle	The line style of the output shape

Cognex Dimensioning Create Segment Avg Segs Control Create Segment By Averaging Segments Output Shape

Graphics Tab

Use the Graphics tab to control which graphics the Create Segment By Averaging tool generates and displays. The following figure shows the Graphics tab:

The Graphics tab offers the following features:

Table 4. Graphics tab

Feature	Description
Show Input Image	Determines 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 SegmentA	Show the first input segment in the LastRun.InputImage buffer
Show SegmentB	Show the second input segment in the LastRun.InputImage buffer
Show Output Segment	Show the line segment that is the average of the two input line segments

Results Tab

Use the Results tab to view results of the line segment that is the average of the two input line segments. The following figure shows the Results tab:

The Results tab offers the following features:

Table 5. Settings tab

Feature	Description
Selected Space Name	Names the coordinate space for the output image
Select Mode	Determines whether the line segment is determined by the 2 Points option (two [x, y] coordinates) or by the Point/Length option (a starting [x, y] coordinate followed by a line length and a measure of rotation).
Start X and Start Y	The starting (x, y) coordinate of the line segment
End X and End Y	The ending (x, y) coordinate of the line segment when using the 2 Points option.