# EditCompositeRegion

Inserts an interactive composite region control into the spreadsheet. When the control is clicked, the display switches to EditCompositeRegion - Interactive Graphics Mode, where the composite region can be modified. A composite region can consist of multiple subregions. A subregion can be an Annulus, Circle, EditPolygon or Region. Each subregion is an add operation (included in the image analysis) or subtract operation (excluded from the image analysis). The subtract operation is also known as "masking".

## Opening the EditCompositeRegion Property Sheet

1. Right-click on a cell and select Insert Function to open the Insert Function Dialog.
2. In the left side of the Insert Function dialog, expand the Graphics list of tool categories.
3. Select the Controls tool category.

4. Select the EditCompositeRegion function from the function list and press the OK button or double-click the function name.

   Note: To access the Property Sheet for EditCompositeRegion, right-click the EditCompositeRegion control button and select Edit Function

Inputs

## General Tab

In the EditCompositeRegion property sheet, the General tab is used to define the parameters of the EditCompositeRegion function.

Parameter | Description
Image | 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.
Fixture | Specifies the image coordinate system in which the input composite region 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)
Add Subregions | If checked (default), subregions can be added in Interactive Graphics Mode.
Remove Subregions | If checked (default), subregions can be removed in Interactive Graphics Mode.
Edit Subregions | If checked (default), subregions can be modified in Interactive Graphics Mode.
Move Entire Composite | If checked (default), the entire composite region can be moved in Interactive Graphics Mode.
Rotate | If checked (default), the entire composite region can be rotated in Interactive Graphics Mode.
Name | Specifies a text label for the EditCompositeRegion control element in the spreadsheet.
Show | Specifies the display mode for the EditCompositeRegion graphics overlay on the image.
0 = hide all | The composite region is hidden, except when the cell containing the EditCompositeRegion function is highlighted in the spreadsheet.
2 = input graphics only | The composite region is displayed at all times.

Note: A maximum of 32 subregions can be added to the composite region.

## Regions Tab

In the EditCompositeRegion property sheet, the Regions tab allows you to add, insert, remove,MoveUp, MoveDown, and edit an ordered list of subregions which make up the total composite region. The type of a subregion can be an Annulus, Circle, EditPolygon or Region that is used to perform an add or subtract operation.

Region Tab Controls

- Add: Adds a new subregion to the end of the list.
- Insert: Inserts a new subregion above the currently highlighted subregion.
- Remove: Removes the highlighted subregion from the list.
- Move Up: Moves the highlighted subregion up in the list.
- Move Down: Moves the highlighted subregion down in the list.

- Subregion Properties: Displays the properties for the highlighted subregion.

## EditCompositeRegion Sequence

The composite region is built in sequence, based on the order of the subregions within the list. The order the operation of each subregion occurs affects the overall area of the composite region.

For Example:
Changing the order of the polygon subregion changes the composite region. The area of the image with blue hash lines is excluded from the image analysis.

# | Type | Operation
--- | --- | ---
1 | Region | Add
2 | Circle | Add
3 | Polygon | Subtract
# | Type | Operation
--- | --- | ---
1 | Region | Add
2 | Polygon | Subtract
3 | Circle | Add

Note: The order of the subregion can be changed in the EditCompositeRegion Property Sheet Regions Tab by selecting the subregion and using MoveUp or MoveDown.
Output

Results | A labeled Button control.