# Image Vision Data Access functions

This topic lists the Vision Data Access functions that reference an Image data structure as the first parameter.

Function | Description
--- | ---
GetArea(Image, [Index]) | Returns the number of pixels processed in an area. The Image structure must be created by a FindCircleDefects function.
GetBrightPixelCount(Image) | Returns the number of pixels above the threshold. The Image structure must be created by a FindCircleDefects function.
GetDarkPixelCount(Image) | Returns the number of pixels below the threshold. The Image structure must be created by a FindCircleDefects function.
GetHeight(Image, [Index]) | Returns a height value.
GetImageFileName(Image) | Returns the file name of the current image. Note: This function must reference AcquireImage in cell A0.
GetPixelSize |
GetPixelValue(Image, Fixture, Point) | Returns the greyscale value, between 0-255, at a specified point in an image.
GetPoint3DFrom2D(Image, X, Y) | Returns a 3D point structure given the 2D coordinate in pixel space on a height map. The function shows an error if the background shape is not at the bottom of the region, the given coordinates are out of range, or there are no points in the region of interest. Note: The 3D point structure is in real world units mm. Note: If the given point does not have a Z data (missing data in the point cloud due to shadowing), the function still returns the 3D point structure, and the Z component is 0 (plane Y=0).
GetRegion(Image) | Returns a Region data structure that contains the region coordinates of the referenced Image function. The output can be used as an External Region parameter reference for 2D Vision Tools that support the External Region parameter.
GetStitchComplete |
GetString(Image) | Returns the string sent to an In-Sight secondary device when it receives a network trigger from an In-Sight primary device. The default Image data structure in cell A0 on the primary system must have a string specified in its Master Data parameter.
GetThresh(Image) | Returns the current binary threshold value. The GetThresh function must reference an Image data structure created by either the Filter function. The Filter Type must be set to Binarize, Greyscale Distance or Sharpen.
GetWidth(Image, [Index]) | Returns a width value.
GetX(Image, [Index1], [Index2]) | Returns the X-coordinate.
GetY(Image, Index) | Returns the Y-coordinate.
GetPoint3DFrom2D(Image, X, Y) | Returns a 3D point structure given the 2D coordinate in pixel space on a height map. The function shows an error if the background shape is not at the bottom of the region, the given coordinates are out of range, or there are no points in the region of interest. Note: The 3D point structure is in real world units millimeter. Note: If the given point does not have a Z data (missing data in the point cloud due to shadowing), the function still returns the 3D point structure, and the Z component is 0 (plane Y=0).
GetImageFileName(Image) | Returns the file name of the current image. Note: This function must reference AcquireImage in cell A0.