# Region

Creates a fixtured Region structure.

Inputs

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

Region(Image, X, Y, Theta, X, Y, Width, Height, Angle, Curve, 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 region is defined.
Row | The row offset.
Column | The column offset.
Theta | The orientation.
Region | Specifies the position, size, rotation, and curvature. Regions are always defined within the coordinate system of a Fixture.
X | The X-offset of the origin, in fixture coordinates.
Y | The Y-offset of the origin, in fixture coordinates.
High | The dimension along the X-axis of the region.
Wide | The dimension along the Y-axis of the region.
Angle | The orientation, in fixture coordinates.
Curve | The angular deviation between the X-axis of the region and the opposing boundary line.
Show | Specifies the display mode for the Region graphic overlay on the image.
0 = hide all (default) | The region structure graphic is hidden unless the cell containing the Region function is highlighted in the spreadsheet.
2 = input graphics only | The region structure graphic is always displayed.

Note: The Fixture and Region parameters must be defined within the bounds of the image. Otherwise, the function returns #ERR.
Outputs

Returns | A region data structure, or #ERR if any of the input parameters are invalid.
Results | When Region is initially inserted into a cell, the following Structures Vision Data Access functions are automatically inserted into the spreadsheet to create a result table:
Label | Function | Description
X | GetX(Region) | The X-coordicate of the origin of the region, in image coordinates.
Y | GetY(Region) | The Y-coordicate of the origin of the region, in image coordinates.
Height | GetHeight(Region) | The height value.
Width | GetWidth(Region) | The width value.
Angle | GetAngle(Region) | The orientation, in image coordinates.
Curve | GetCurve(Region) | The angular deviation between the X-axis of the region and the opposing boundary line.