IMAQ Edge Tool 3 VI

Download PDF

Updated2023-02-21
7 minute(s) read

Owning Palette: Caliper
Requires: NI Vision Development Module

Finds edges along a path defined in the image.

Supported Image Types

8-bit unsigned grayscale 16-bit unsigned grayscale 32-bit RGB 16-bit signed grayscale 64-bit RGB floating point grayscale 32-bit HSL

IMAQ Edge Tool 3

Optimized Mode, when TRUE, enables a faster edge detection algorithm that does not return gradient values. When FALSE, enables a standard edge detection algorithm that returns gradient values. The default is TRUE.

Edge Options specifies the parameters that are used to compute the edge gradient information and detect the edges.

Edge Polarity specifies the polarity of the edges to be found.

All Edges (0)	(Default) Searches for all edges
Rising Edges (1)	Searches for rising edges
Falling Edges (2)	Searches for falling edges

Kernel Size specifies the size of the edge detection kernel. The default is 3.

Width specifies the number of pixels averaged perpendicular to the search direction to compute the edge profile strength at each point along the search ROI. The default is 3.

Minimum Edge Strength specifies the minimum edge strength (gradient magnitude) required for a detected edge. The default is 10.

Interpolation Type specifies the interpolation method used to locate the edge position.

Choose from the following options:

Zero Order (0)	Rounds to the nearest integral edge location
Bilinear (1)	Uses bilinear interpolation to compute the edge location
Bilinear Fixed (4)	(Default) Uses the fixed-point computation of bilinear interpolation to determine the edge location

Data Processing Method is the method used to process the data extracted for edge detection.

Average (0)	(Default) Averages the data extracted for edge detection
Median (1)	Takes the median of the data extracted for edge detection

Image is a reference to the source image.

ROI Descriptor is a descriptor that defines the rectangle, rotated rectangle, annulus, oval, line, broken line, polygon, or freehand region within which edge detection is performed.

Global Rectangle contains the coordinates of the bounding rectangle.

Contours are each of the individual shapes that define an ROI.

	ID refers to whether the contour is the external or internal edge of an ROI.
	Type is the shape type of the contour.
	Coordinates indicates the relative position of the contour.

Process determines the type of search. Choose from the following values:

Get First Edge (0)	Returns the first edge.
Get First + Last Edge (1)	Returns the first and last edge.
Get All Edges (2)	(Default) Returns all edges found along the search path(s).
Get Best Edge (3)	Returns the strongest edges found along the search path(s).

error in (no error) describes the error status before this VI or function runs. The default is no error. If an error occurred before this VI or function runs, the VI or function passes the error in value to error out. This VI or function runs normally only if no error occurred before this VI or function runs. If an error occurs while this VI or function runs, it runs normally and sets its own error status in error out. Use the Simple Error Handler or General Error Handler VIs to display the description of the error code. Use error in and error out to check errors and to specify execution order by wiring error out from one node to error in of the next node.

	status is TRUE (X) if an error occurred before this VI or function ran or FALSE (checkmark) to indicate a warning or that no error occurred before this VI or function ran. The default is FALSE.
	code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
	source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.

Reverse Direction, when TRUE, reverses the direction that the ROI traverses to find edges.

Image (duplicate) is a reference to the source image.

Edge Information is an array that contains information about each detected edge.

	Location (Pixel) is the location of the edge point in the image in pixel units.
	Location (Real-World) is the location of the edge point in the image in calibrated units. When the image is not calibrated, this is the location is in pixel units.
	Distance (Pixel) is the location of the edge from the first point of the search line along the boundary of the input ROI in pixels.
	Distance (Real-World) is the location of the edge from the first point of the search line along the boundary of the input ROI in calibrated units. When the image is not calibrated, this distance is in pixel units.
	Strength is the strength (gradient magnitude) at the located edge.
	Noise is the strength of the noise associated with the current edge.
	Rising? indicates the polarity of the edge. If TRUE, the edge is a Rising Edge.

Calibration Valid indicates if the calibration information associated with the edges found along the search line is valid. If the calibration information is invalid for any pixel that is used for edge detection, the Calibration Valid Boolean is FALSE.

Gradient Values is an array that contains the calculated edge strengths along the user-defined search area.

error out contains error information. If error in indicates that an error occurred before this VI or function ran, error out contains the same error information. Otherwise, it describes the error status that this VI or function produces. Right-click the error out indicator on the front panel and select Explain Error from the shortcut menu for more information about the error.

	status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.
	code is the error or warning code. If status is TRUE, code is a nonzero error code. If status is FALSE, code is 0 or a warning code.
	source describes the origin of the error or warning and is, in most cases, the name of the VI or function that produced the error or warning. The default is an empty string.

Examples

Refer to the following for an example that uses this VI.

LabVIEW\examples\Vision\Caliper\Edge Detection.vi

NI Vision for LabVIEW

Table of Contents

IMAQ Edge Tool 3 VI

Supported Image Types

Examples

Log in to get a better experience