# LineToCircle

Computes the minimum distance between a line and a circle.

Inputs

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

LineToCircle(Image, X0, Y0, X1, Y1, X, Y, Radius, 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 A1.
Line | Specifies the coordinates of the line.
X 0 | The X coordinate of the first endpoint of the line.
Y 0 | The Y coordinate of the first endpoint of the line.
X 1 | The X coordinate of the second endpoint of the line.
Y 1 | The Y coordinate of the second endpoint of the line.
Circle | Specifies the coordinates and the size of the circle.
X | The X coordinate of the center of the circle.
Y | The Y coordinate of the center of the circle.
Radius | The radius of the circle, in pixels.
Show | Specifies the display mode for the graphical overlays of the function on top of the image.
0 = hide all (default) | All graphics are hidden, except when the cell containing the function is highlighted in the spreadsheet.
1 = result graphics only | A line segment showing the minimum distance between the input line and the circle is displayed at all times.
2 = input and result graphics | The input line and circle, and the line segment between them, are displayed at all times.

Outputs

Returns | If the line and the circle do not intersect, the function returns a Dist data structure containing a point on the line, a point on the circle, the distance between points, and the angle of the directed distance. If the line and circle intersect, the function returns a Dist data structure containing the two points of intersection, the angle of line segment, and a distance of exactly 0.
Results | When the function is initially inserted into a cell, a result table is created in the spreadsheet.

Vision Data Access functions

The following Dist Vision Data Access functions are automatically inserted into the spreadsheet to create the result table:

Label | Function | Description
--- | --- | ---
X0 | GetX(Dist, 0) | If not intersecting, the X coordinate of a point on the first circle. If intersecting, the X coordinate of the first point of intersection.
Y0 | GetY(Dist, 0) | If not intersecting, the Y coordinate of a point on the first circle. If intersecting, the Y coordinate of the first point of intersection.
X1 | GetX(Dist, 1) | If not intersecting, the X coordinate of a point on the second circle. If intersecting, the X coordinate of the second point of intersection.
Y1 | GetY(Dist, 1) | If not intersecting, the Y coordinate of a point on the second circle. If intersecting, the Y coordinate of the second point of intersection.
Angle | GetAngle(Dist) | The point-to-point angle.
Distance | GetDistance(Dist) | If not intersecting, the distance between points. Otherwise, 0.