Table Of Contents

Overlay Motion Vectors (G Dataflow)

Last Modified: June 25, 2019

Overlays velocity information on an image.

connector_pane_image
datatype_icon

step size

Gap between the pixels at which the velocity information is overlayed.

datatype_icon

group name

Group to which you want to add the overlay information.

If no name is specified, the overlay information is added to the default group.

datatype_icon

image in

Reference to the source image.

datatype_icon

velocity component 1

Reference to the image that contains the horizontal component or the magnitude component of the velocity information at each pixel that needs to be overlayed.

datatype_icon

velocity component 2

Reference to the image that contains the vertical component or the phase component of the velocity information at each pixel that needs to be overlayed.

datatype_icon

velocity representation

Input velocity information represented in Cartesian or polar coordinates.

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

color

Color of the overlay.

The alpha color channel is not supported. Setting the color to transparent has the same effect as selecting black.

datatype_icon

scale

Factor by which the vectors that represent the velocity are scaled before being overlayed on the image.

datatype_icon

threshold

Minimum magnitude of the velocity information at each pixel that is overlayed on the image.

datatype_icon

image out

Reference to the destination image.

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.

Overlay Behavior

Overlays are nondestructive, which means that they do not overwrite the underlying pixel values. You can save overlay information with an image by using the Read Image and Vision Information node. If you want to replace the underlying pixel values with the overlay values, use the Merge Overlay node.

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