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. For more information, see Interactive Graphics Mode.

Note:

To access the property sheet for EditAnnulus, right-click the EditAnnulus control and select Edit Function.
If the External Region parameter (e.g. ExtractBlobs function) references an EditAnnulus function whose Internal Radius parameter is set to zero, #ERR may be returned. In this circumstance, use an EditCircle function instead of the EditAnnulus function. For more information, see EditCircle.

EditAnnulus Inputs

Syntax: EditAnnulus(Image,Fixture.Row,Fixture.Column,Fixture.Theta,Move,Size,Name,Show)

Parameter

Description

Image

This parameter must reference a spreadsheet cell that contains an Image data structure; by default, this parameter references A0, the cell containing the AcquireImage Image data structure. This parameter can also reference other Image data structures, such as those returned by the Vision Tool Image functions or Coordinate Transforms Functions.

Fixture

Specifies the image coordinate system in which the input annulus is defined.

Row	The row offset in image coordinates.
Column	The column offset in image coordinates.
Theta	The orientation in image coordinates.

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 will be hidden, except when the cell containing the EditAnnulus function is highlighted in the spreadsheet.
2 = input graphics only	The annulus will be displayed at all times.

EditAnnulus Outputs

Results

A result table will automatically be created in the cells adjacent to the right of the EditAnnulus control.

EditAnnulus Vision Data Access Functions

The following Vision Data Access functions are automatically inserted into the spreadsheet to create the result table. For more information, see Structures.

Row	GetRow(Annulus)	The row offset of the center of the annulus, in image coordinates.
Col	GetCol(Annulus)	The column 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.