# LatchImage

Stores (latches) an image on the specified event.

Inputs

The LatchImage function Functions are tools that are available in Spreadsheet for processing and analyzing acquisitions or other results. You can add functions to your Spreadsheet job to create tool chains and produce results for specific applications. has the following syntax:

LatchImage(Image, Fixture A fixture is a coordinate location on the image that keeps the tool in the place determined by the fixture.(X, Y, Theta), Region(X, Y, Width, Height, Angle), Event, Colorize, Show)

See the table for a description of the available parameters.

Parameters | Description
Image | This argument must reference a spreadsheet cell that contains a valid Image data structure. By default, the cell referenced is cell A1 .
Fixture | Defines the Region of Interest (ROI) relative to a Fixture input or the output of the image coordinate system for the Vision Tools function. Setting the ROI relative to a Fixture ensures that if the Fixture is rotated or translated, the ROI is rotated or translated in relation to the Fixture. Note: 2D projections use real world units but fixturing with 2D tools requires input in pixel values. When using a 2D projection from a 3D point cloud A point cloud is a 3D structure that consists of the data points collected by a 3D vision system during acquisition. as a Fixture, convert the real world units to pixel values using the TransWorldToPixel function. Note: Angles must be multiplied by -1, due to image space differences. The default setting is (0,0,0), the top leftmost corner of the image.
X | Specifies the X-offset, in image coordinates.
Y | Specifies the Y-offset, in image coordinates.
Theta | Specifies the orientation, in image coordinates.
Region | Also known as the Region of Interest (ROI), specifies the region of the image that undergoes image processing, and creates a Region that can be transformed and rotated. With this parameter selected, pressing the button automatically stretches the region to cover the entire image.
X | Specifies the X-offset of the origin, in fixture coordinates.
Y | Specifies the Y-offset of the origin, in fixture coordinates.
Width | Specifies the dimension along the X-axis of the region.
Height | Specifies the dimension along the Y-axis of the region.
Angle | Specifies the orientation, in fixture coordinates.
Note: The Fixture and Region parameters must be defined within the bounds of the image. Otherwise, the function returns #ERR.
Event | Specifies the update event on which to store the image. This parameter must be a reference to one of the following: The Image data structure in cell A1 . A cell containing a Button function.
Colorize | Only relevant for color images. When disabled, the latched image is converted to greyscale, otherwise it remains colorful.
0 = Disabled (default)
1 = Enabled
Show | Specifies which graphical overlays are displayed on top of the image.
0 = hide all (default) | The available graphics items are hidden except when the cell containing the function is the active cell in the spreadsheet. Note: If the input region changes, a second region is displayed, indicating where the latching occurs on the next specified event.
1 = results graphics only | The processed image is always displayed.
2 = input graphics only | The graphics items associated with the input image region are always displayed.

Outputs

Returns | A LatchImage data structure with the image stored on the last event.