LatchImage

Stores (latches) an image on the specified event.

LatchImage Inputs

Parameters Description

Image

This argument must reference a spreadsheet cell that contains a valid Image data structure. By default, the cell referenced is A0, the cell containing the Image data structure returned byAcquireImage.

Fixture

Defines the Region of Interest (ROI) relative to a Fixture input or the output of an image coordinate system of 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.

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 A0 (the default, containing the AcquireImage function).
  • 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.

LatchImage Outputs

Returns

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