imaqCaliperTool

NI Vision for LabWindows/CVI Function

imaqCaliperTool

Usage

CaliperReport* imaqCaliperTool(const Image* image, const Point* points, int numPoints, const EdgeOptions* edgeOptions, const CaliperOptions* caliperOptions, int* numEdgePairs);

Purpose

Finds edges along a path in an image, chooses pairs of the edges, and measures the distance between those pairs.

Image Types Supported

IMAQ_IMAGE_U8, IMAQ_IMAGE_I16, IMAQ_IMAGE_SGL

Parameters

Name

Type

Description

image const Image* The image in which the function finds edges.
points const Point* The path along which the function detects edges. This parameter is required and cannot be NULL.
numPoints int The number of points in the points array.
edgeOptions const EdgeOptions* Describes how you want the function to find an edge. This parameter is required and cannot be NULL.
caliperOptions const CaliperOptions* Describes how you want the function to choose edge pairs. This parameter is required and cannot be NULL.
numEdgePairs int* On return, this parameter is set to the number of edge pairs found. If you do not need this information, set this parameter to NULL.

Return Value

Type

Description

CaliperReport* On success, this function returns an array of information about each edge pair. On failure, this function returns NULL. To get extended error information, call imaqGetLastError(). When you are finished with the return value, dispose of this function by calling imaqDispose().