IMAQ ROIProfile VI

NI Vision 2019 for LabVIEW Help

Edition Date: March 2019

Part Number: 370281AG-01

»View Product Info
Download Help (Windows Only)
Owning Palette: Analysis
Requires: NI Vision Development Module

Calculates the profile of the pixels along the boundary of an ROI descriptor. This VI returns a data type (cluster) that is compatible with a LabVIEW graph. This VI also returns other information such as pixel statistics and the coordinates of the pixels along the ROI boundary.

Examples

Supported Image Types

8-bit unsigned grayscale 16-bit unsigned grayscale 16-bit signed grayscale floating point grayscale

IMAQ ROIProfile

/images/reference/en-XX/help/370281AG-01/cgenclasstagrefflat.gif

Image is a reference to the source image.

/images/reference/en-XX/help/370281AG-01/ccclst.gif

ROI Descriptor is a descriptor that defines the region of interest.

/images/reference/en-XX/help/370281AG-01/c1di32.gif

Global Rectangle is the minimum rectangle required to contain all of the contours in the ROI.

/images/reference/en-XX/help/370281AG-01/c1dcclst.gif

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

/images/reference/en-XX/help/370281AG-01/cenum.gif

ID refers to whether the contour is the external or internal edge of an ROI.

/images/reference/en-XX/help/370281AG-01/cu32.gif

Type is the shape type of the contour.

/images/reference/en-XX/help/370281AG-01/c1di32.gif

Coordinates indicates the relative position of the contour.

/images/reference/en-XX/help/370281AG-01/cerrcodeclst.gif

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.

/images/reference/en-XX/help/370281AG-01/cbool.gif

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.

/images/reference/en-XX/help/370281AG-01/ci32.gif

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.

/images/reference/en-XX/help/370281AG-01/cstr.gif

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.

/images/reference/en-XX/help/370281AG-01/icclst.gif

ROI Graph is a cluster that contains the ROI profile with an x-origin at 0 and an increment of 1. The cluster contains the following elements:

/images/reference/en-XX/help/370281AG-01/isgl.gif

x0 always returns 0.

/images/reference/en-XX/help/370281AG-01/isgl.gif

dx always returns 1.

/images/reference/en-XX/help/370281AG-01/i1dsgl.gif

Pixels Line returns the ROI profile calculated in an array in which elements represent the pixel values belonging to the specified vector.

/images/reference/en-XX/help/370281AG-01/i1dnclst.gif

Pixel Coordinates is an array containing the spatial coordinates of each pixel along the ROI boundary.

/images/reference/en-XX/help/370281AG-01/inclst.gif

ROI Pixel Statistics is a cluster containing relevant information about the pixels found along the ROI boundary. The cluster contains the following elements:

/images/reference/en-XX/help/370281AG-01/isgl.gif

Min returns the smallest pixel value found in the ROI profile.

/images/reference/en-XX/help/370281AG-01/isgl.gif

Max returns the largest pixel value found in the ROI profile.

/images/reference/en-XX/help/370281AG-01/isgl.gif

Mean returns the mean value of the pixels found in the ROI profile.

/images/reference/en-XX/help/370281AG-01/isgl.gif

Std Dev returns the standard deviation from the ROI profile.

/images/reference/en-XX/help/370281AG-01/ii32.gif

Count returns the count of pixels found in the ROI profile.

/images/reference/en-XX/help/370281AG-01/ierrcodeclst.gif

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.

/images/reference/en-XX/help/370281AG-01/ibool.gif

status is TRUE (X) if an error occurred or FALSE (checkmark) to indicate a warning or that no error occurred.

/images/reference/en-XX/help/370281AG-01/ii32.gif

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.

/images/reference/en-XX/help/370281AG-01/istr.gif

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.

/images/reference/en-XX/help/370281AG-01/inclst.gif

Global Rectangle is a cluster that contains the coordinates of a bounding rectangle for the ROI in the image. This cluster includes the following parameters:

/images/reference/en-XX/help/370281AG-01/ii32.gif

x1Left indicates the x-coordinate of the top-left corner of the rectangle.

/images/reference/en-XX/help/370281AG-01/ii32.gif

y1Top indicates the y-coordinate of the top-left corner of the rectangle.

/images/reference/en-XX/help/370281AG-01/ii32.gif

x2Right indicates the x-coordinate of the bottom-right corner of the rectangle.

/images/reference/en-XX/help/370281AG-01/ii32.gif

y2Bottom indicates the y-coordinate of the bottom-right corner of the rectangle.

Examples

Refer to the following for examples that use this VI.

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

WAS THIS ARTICLE HELPFUL?

Not Helpful