# Annulus

Creates a fixtured Annulus structure.

Inputs

The Annulus 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:

Annulus(Image, X, Y, Theta, X, Y, InnerRadius, OuterRadius, Show)

See the table for a description of the available parameters.

Parameter | Description
Image | This argument must reference a spreadsheet cell that contains a valid Image data structure. By default, the cell referenced is cell A0, containing the Image data structure returned by the AcquireImage function.
Fixture A fixture is a coordinate location on the image that keeps the tool in the place determined by the fixture. | Specifies the image coordinate system in which the annulus is defined.
X | The X-offset of the image.
Y | The Y-offset of the image.
Theta | Rotation from image X-axis.
Annulus | Specifies the size and position of the annulus.
X | The X-offset, in fixture coordinates.
Y | The Y-offset, in fixture coordinates.
Inner Radius | The inner radius.
Outer Radius | The outer radius.
Note: The Fixture and Annulus parameters must be defined within the bounds of the image. Otherwise, the function returns #ERR.
Show | Specifies the display mode for the annulus graphic overlay on the image.
0 = hide all | The annulus structure graphic is not be displayed unless the cell containing the Annulus function is highlighted in the spreadsheet.
2 = input graphics only | The annulus structure graphic is always displayed.

Outputs

Returns | An Annulus data structure, or #ERR if any of the input parameters are invalid.
Results | When Annulus is initially inserted into a cell, a result table is created in the spreadsheet with the following Structures Vision Data Access functions
Label | Function | Description
X | GetX(Annulus) | The X-offset of the center of the annulus, in image coordinates.
Y | GetY(Annulus) | The Y-offset of the center of the annulus, in image coordinates.
Inner Radius | GetRadius(Annulus, 0) | The inner radius of the indexed annulus.
Outer Radius | GetRadius(Annulus, 1) | The outer radius of the indexed annulus.