Polar Unwrap Tool Edit ControlCognex VisionPro

This topic contains the following sections.

The Polar Unwrap tool edit control provides a graphical user interface to the CogPolarUnwrapTool tool, which you use to transform the portion of an image contained within a defined region into a rectangular image. The tool produces an output image containing the transformed portion of the input region. The edit control allows you to specify a sampling mode, scaling factors, and the type of region shape to use. The following figure shows the Polar Unwrap tool edit control:

Cognex Image Processing Polar Unwrap Polar Unwrap Whole Control

The edit control offers the following features:

  • A row of control buttons at the top left provide access to the most common operations.
  • A set of function tabs allow you to choose the sampling mode, the scaling factors, and the region shape.
  • An image display window displays acquired images and the output image the Polar Unwrap tool generates.

You can experiment with the edit control by using QuickBuild to create a CogPolarUnwrap tool. A new CogPolarUnwrap tool appears with the input terminals for the input image and output image, as shown in the following figure:

Cognex Image Processing Polar Unwrap Polar Unwrap Terminals

Control Buttons

Cognex Image Processing Polar Unwrap Polar Unwrap Tool Button Bar

The following table describes the function of each button:

Table 1. Control buttons
ButtonDescriptionFunction
Run Button
RunGenerate an output image of the defined region transformed into a rectangular image.
Electric Button
Electric modeToggle electric mode, where the Polar Unwrap 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

Open or close the local image display window. A Polar Unwrap tool supports the following image buffers:

  • The Current.InputImage buffer contains the next image the tool will analyze plus the graphic for the input region.
  • The LastRun.InputImage buffer contains the last image processed by the Polar Unwrap tool along with any graphics you enable.
  • The LastRun.OutputImage buffer contains the output image the tool produces.
Floating Display Button
Floating image displayOpen a floating image window, which supports the same image buffers as the local image display window.
Open Button
OpenOpen 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 Button
SaveSave 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 AsSave the current properties of the vision tool to a new VisionPro persistence (.vpp) file.
Reset Button
ResetReset the vision tool to its default state.
Tool Tips Button
Show ToolTipsEnable or disable the display of tooltips for individual items in the edit control.
Help Button
HelpOpen this VisionPro online help file.
Settings Tab

Use the Settings tab to select a sampling mode and the scaling factor you want to use. The following figure shows the default Settings tab:

Cognex Image Processing Polar Unwrap Polar Unwrap Settings Tab

Use the following options to configure the tool:

Table 2. Settings Tab
ParameterDescription
SamplingModeSpecifies the sampling mode you want to use during the unwrap operation.
ScalingXSpecifies the scaling factor for the x-axis in the output image, which corresponds to the angular span direction.
ScalingYSpecifies the scaling factor for the y-axis in the output image, which corresponds to the radial direction.
Region Tab

Use the Region tab to select the shape of the input region. The following figure shows the default Region tab:

Cognex Image Processing Polar Unwrap Polar Unwrap Region Tab

Use the following options to configure the input region:

Table 3. Region Tab
ParameterDescription

Region

Choose either CogCircularAnnulusSection or CogEllipticalAnnulusSection.

For CogCircularAnnulusSection, configure the following parameters:

For CogEllipticalAnnulusSection, configure the following parameters:

SelectedSpaceNameThe coordinate space in which the training region is interpreted. For information, see Coordinate Space Names.
FitToImageCenters the region within the image, adjusting its geometric properties so that its default size is based on the image and its SelectedSpaceName.
Graphics Tab

Use the Graphics tab to specify the graphics that the tool generates and displays. The following figure shows the Graphics tab:

Cognex Image Processing Polar Unwrap Polar Unwrap Graphics Tab

Use the following options on the Graphics tab:

Table 4. Graphic Options
OptionDescription
Show Output ImageYou can choose not to generate an image record for the output image.
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 RegionShow the CogCircularAnnulusSection or CogEllipticalAnnulusSection shape in the LastRun.InputImage buffer.