# EditAnnulus

Inserts an interactive annulus control into the spreadsheet. When the control is clicked, the display switches to Interactive Graphics Mode, where the position and size of the annulus can be adjusted.

Note: To access the Property Sheet for EditAnnulus, right-click the EditAnnulus control and select Edit 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.. If the External Region parameter (such as DetectBlobs function) references an EditAnnulus function whose Internal Radius parameter is set to 0, #ERR may be returned. In this circumstance, use an EditCircle function instead of the EditAnnulus function.

Inputs

The EditAnnulus function has the following syntax:

EditAnnulus(Image, X, Y, Theta, Move, Size, Name, Show)

See the table for a description of the available parameters.

Parameter | Description
Image | This parameter uses Cell References to a spreadsheet cell that contains an Image data structure. This parameter must reference a spreadsheet cell that contains an Image data structure. By default, this parameter references cell A0, the cell containing the Image data structure returned by the AcquireImage function. This parameter can also reference other Image data structures, such as those returned by the Vision Tool Image Functions or Coordinate Transforms Functions. This parameter can also reference other Image data structures, such as those returned by the Vision Tool Image functions or Coordinate Transforms Functions.
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 input annulus is defined.
X | The X-offset of the origin, in fixture coordinates.
Y | The Y-offset of the origin, in fixture coordinates.
Theta | The rotation from the image X-axis, in the image coordinate system. (+/-360 degrees clockwise)
Move | Disables or enables the ability to adjust the input annulus position.
0 = OFF | Annulus cannot be moved.
1 = ON (default) | Annulus can be moved.
Size | Disables or enables the ability to adjust the input annulus radii.
0 = OFF | Annulus cannot be resized.
1 = ON (default) | Annulus can be resized.
Note: Both the inner radius and the outer radius of the annulus can be adjusted.
Name | Specifies a text label for the EditAnnulus control element in the spreadsheet.
Show | Specifies the display mode for the EditAnnulus graphics overlay on the image.
0 = hide all | The annulus is hidden, except when the cell containing the EditAnnulus function is highlighted in the spreadsheet.
2 = input graphics only | The annulus is displayed at all times.

Outputs

Results | A result table will automatically be created in the cells adjacent to the right of the EditAnnulus control. The following Structures Vision Data Access functions are automatically inserted into the spreadsheet to create the result table:
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 annulus.
Outer Radius | GetRadius(Annulus, 1) | The outer radius of the annulus.