LatchImage

Stores (latches) an image on the specified event.

LatchImageInputs

Syntax: LatchImage(Image,Fixture.Row,Fixture.Column,Fixture.Theta,Region.X,Region.Y,Region.High,Region.Wide,Region.Angle,Event,Colorize,Show)

Note: The Fixture and Region parameters must be defined within the bounds of the image; otherwise, the function will return #ERR.
Parameter Description

Image

This argument must reference a spreadsheetcell that contains a valid Image data structure.By default, the cell referenced isA0, the cell containing the Image data structure returned by AcquireImage.

Fixture

Defines the Region of Interest (ROI) relativeto a Fixture input or the output of a VisionTool function's image coordinate system.Setting the ROI relativeto a Fixture ensures that if the Fixture is rotated or translated, theROI will be rotated or translated in relation to the Fixture.

Note: The default setting is (0,0,0), the top leftmost corner of the image.

Row

Specifies the row offset, in imagecoordinates.

Column

Specifies the column offset, in imagecoordinates.

Theta

Specifies the orientation, in imagecoordinates.

Region

Also known as the Region of Interest (ROI),specifies the region of the image that undergoes image processing; createsa rectangularimage region that can be transformed and rotated.With this parameterselected, pressing the MaximizeRegion button will automatically stretch the region to cover the entireimage.

X

Specifies the x-offset of the origin,in fixture coordinates.

Y

Specifies the y-offset of the origin,in fixture coordinates.

High

Specifies the dimension along theregion's x-axis.

Wide

Specifies the dimension along theregion's y-axis.

Angle

Specifies the orientation, in fixturecoordinates.

Event

Specifies the update event on which to storethe image. This parameter must be a reference to one of the following:

  • The Image data structure in cell A0, containing the AcquireImage function. For more information, see AcquireImage.
  • A cell containing an Event function. For more information, see Event.
  • A cell containing a Button function. For more information, see Button.

Colorize

Only relevant for color images.When disabled, the latched image will be converted to greyscale (otherwise it remains in color).

0 = Disabled (default)

1 = Enabled

Show

Specifies which graphical overlays are displayedon top of the image.

0 = hide all (default)

The available graphics items willbe hidden except when the cell containing the function is the active cellin the spreadsheet.

Note: If the input region changes, a second region is displayed, indicating where the latching will occur on the next specified event.

1 = results graphics only

The processed image will be displayedat all times.

2 = input graphics only

The graphics items associated withthe input image region will be will be displayed at all times.

LatchImageOutputs

Returns

A LatchImage data structure that contains the image stored on the last event.