Create ROI

Operator Function

Create ROI arrays according to requirements, can create 1-100 ROIs. Operation method is as follows:

1. Select the required ROI type to create
2. Adjust the position and size of ROI with sequence number 0
3. Use ctrl+c to copy, ctrl+v to paste, delete to remove, esc to exit copy/paste mode
   Note: Maximum 100 ROIs can be created (sequence numbers 0-99), minimum 1 ROI (sequence number 0)

Parameter Introduction

Input Parameters

Parameter	Range	Default Value	Description	Illustration
Input Image	0-8	0	The IM number for image input

Calculation Parameters

Parameter	Range	Default Value	Description	Illustration
Mode	Recipe/Region	Region	Select ROI creation mode: recipe input or manual creation via region
Recipe File			Recipe file path
Region Type	2D Window Array/2D Circular Window Array/2D Polygon Window/Box Array/Cylinder Box Array/Rotated Box Array	Box Array
Type	2D Window Array/2D Circular Window Array/2D Polygon Window/Box Array/Cylinder Box Array/Rotated Box Array	Box Array	Select required ROI type
Sequence Number	All created ROIs	0		Each copy automatically increments sequence number by 1 in order; deleting an ROI decrements all subsequent ROI sequence numbers by 1 (all ROIs maintain order 0-99), maximum value 99, minimum value 0

Result Display

Parameter	Range	Default Value	Description	Illustration
ROI	true/false	false	If enabled, display created ROIs in the image

Output Parameters

Name	Type	Range	Description
Result	bool	true/false	true for success false for failure
Warning	bool	true/false	true indicates there is a warning false indicates there is none
Message	string		Outputs success, error, or warning information; if there is no error or warning, it is empty
Time	float		Operator execution time, unit: ms
ROI	window2d[]/circlewindow2d[]/polygon2d/ box[]/cylinderbox[]/orientedbox[]		Output ROI

Tip

For more detailed explanations of parameter types, please refer to... [add link to parameter type introduction]...

Exception Troubleshooting

No.	Exception Information	Corresponding Parameter	Solution
1	Input ROI type is {0}, invalid ROI type	ROI Type	Select region type as one of: 2D Window Array/2D Circular Window Array/2D Polygon Window/Box Array/Cylinder Box Array/Rotated Box Array
2	Input 2D window parameter for {0}th ROI is invalid	Sequence Number	Ensure difference between start and end points in any x or y coordinate is not 0
3	Input box parameter for {0}th ROI is invalid	Sequence Number	Ensure difference between start and end points in any x, y, z coordinate is not 0
4	Input polygon vertex count less than 3, cannot form polygon		Add 2D polygon window vertices so vertex count is at least three
5	File "{0}" does not exist or cannot be accessed	File Name	Input valid recipe path
6	File "{0}" failed to load	File Name	Input valid path and must be a json file
7	File does not contain key {0}.	Key Name	Check if recipe file contains this key
8	No "{1}" in {0}th array	Group Number, Parameter Name	Check if this array is missing this parameter

Example Introduction

Engineering Design

1. Select the Load Point Cloud tool to load the 3D point cloud image to be processed into IM0;

2. Select the Create ROI tool.

Tool Usage

1. Select the input image for operation; the image number must match the IM number where the image is located in the project.

2. Select the region type as the required ROI type, move the ROI to the position to be measured, and perform operations such as copying and adjusting.

Usage Tips

1. Use the ROI controller on the image window to drag or scale the box;
2. Directly modify the start or end coordinates of the box in the calculation parameters to adjust the box position and size.

4. Check the content you want to display in the result display section.

5. Click Test to check if the image window and parameters meet expectations.

6. If there are no issues, click Save, then run the operator in the run list to view the results in the corresponding IM.

2D Window Array

2D Circular Window Array

Box Array

Cylinder Box Array