Table Of Contents

Edge Tool (G Dataflow)

Last Modified: June 25, 2019

Finds edges along a path defined in the image.

connector_pane_image
datatype_icon

optimized mode?

Boolean that specifies when an edge detection algorithm returns gradient values.

TRUE Edge detection algorithm that does not return gradient values.
FALSE Standard edge detection algorithm that returns gradient values.

Default: TRUE

datatype_icon

image in

Reference to the source image.

datatype_icon

ROI descriptor

Rectangle, rotated rectangle, annulus, oval, line, broken line, polygon, or freehand region within which edge detection is performed.

datatype_icon

global rectangle

Coordinates of the bounding rectangle.

datatype_icon

contours

Individual shapes that define an ROI.

datatype_icon

ID

Object specifying if contour is the external or internal edge of an ROI.

datatype_icon

Type

Shape type of the contour.

datatype_icon

Coordinates

Relative position of the contour.

datatype_icon

edge options

Inputs used to compute the edge gradient information and detect the edges.

datatype_icon

edge polarity

Polarity of the edges to be found.

Name Value Description
all edges 0

(Default) Searches for all edges

rising edges 1

Searches for rising edges

falling edges 2

Searches for falling edges

datatype_icon

kernel size

Size of the edge detection kernel.

Default: 3

datatype_icon

width

Number of pixels averaged perpendicular to the search direction to compute the edge profile strength at each point along the search ROI.

Default: 3

datatype_icon

minimum edge strength

Minimum edge strength, or gradient magnitude, required for a detected edge.

Default: 10

datatype_icon

interpolation type

Interpolation method used to locate the edge position.

Name Description
zero order Rounds to the nearest integral edge location
bilinear Uses bilinear interpolation to compute the edge location
bilinear fixed (Default) Uses the fixed-point computation of bilinear interpolation to determine the edge location
datatype_icon

data processing method

Method used to process the data extracted for edge detection.

Name Description
average (Default) Averages the data extracted for edge detection
median Takes the median of the data extracted for edge detection
datatype_icon

process

Type of search returned.

Name Description
get first edge Returns the first edge.
get first + last edge Returns the first and last edge.
get all edges Returns all edges found along the search path(s).
get best edge Returns the strongest edges found along the search path(s).

Default: get all edges

datatype_icon

error in

Error conditions that occur before this node runs.

The node responds to this input according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Default: No error

datatype_icon

reverse direction?

Boolean that reverses the direction that the ROI traverses to find edges.

TRUE Reverses the direction that the ROI traverses to find edges.
FALSE Maintains current direction.
datatype_icon

image out

Reference to the source image.

datatype_icon

edge information

Array that contains information about each detected edge.

datatype_icon

location (pixel)

Location of the edge point in the image in pixel units.

datatype_icon

location (real-world)

Location of the edge point in the image in calibrated units.

When the image is not calibrated, this is the location in pixel units.

datatype_icon

distance (pixel)

Location of the edge from the first point of the search line along the boundary of the input ROI in pixels.

datatype_icon

distance (real-world)

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.

datatype_icon

strength

Strength, or gradient magnitude, at the located edge.

datatype_icon

noise

Strength of the noise associated with the current edge.

datatype_icon

rising?

Boolean that specifies the polarity of the edge.

TRUE The edge is a rising edge.
FALSE The edge is not a rising edge.
datatype_icon

gradient values

Array that contains the calculated edge strengths along the user-defined search area.

datatype_icon

calibration valid

Boolean that indicates if the calibration information associated with the edges found along the search line is valid.

TRUE Calibration information is valid.
FALSE Calibration information is invalid for any pixel that is used for edge detection.
datatype_icon

error out

Error information.

The node produces this output according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Where This Node Can Run:

Desktop OS: Windows

FPGA: Not supported

Web Server: Not supported in VIs that run in a web application


Recently Viewed Topics