Convert to ROI (Convert Rectangle to ROI) (G Dataflow)

Converts a rectangle or rotated rectangle to an ROI Descriptor. The contour of the ROI Descriptor returned is always of the type rotated rectangle.

rectangle

Rectangular region.

The left, top, right, and bottom coordinates describe a non-rotated rectangle. The rotation parameter specifies the rotation angle of the rectangle around its center.

left

X-coordinate of the upper left corner of the rectangle.

top

Y-coordinate of the upper left corner of the rectangle.

right

X-coordinate of the bottom right corner of the rectangle.

bottom

Y-coordinate of the bottom right corner of the rectangle.

rotation

Rotation angle in degrees of the rectangle with its center as point of rotation.

If the rotation angle does not equal zero, the left, top, right, and bottom coordinates are not the actual coordinates of the upper left and bottom right corner of the rectangle. Instead these coordinates are a position, if the rotation angle equals zero.

error in

Error conditions that occur before this node runs.

The node responds to this input according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Default: No error

ROI descriptor

Descriptor that defines the rectangle.

global rectangle

Coordinates of the bounding rectangle.

contours

Individual shapes that define an ROI.

ID

Control specifying whether the contour is the external or internal edge of an ROI.

type

Shape type of the contour.

coordinates

Relative position of the contour.

error out

Error information.

The node produces this output according to standard error behavior.

Standard Error Behavior

Many nodes provide an error in input and an error out output so that the node can respond to and communicate errors that occur while code is running. The value of error in specifies whether an error occurred before the node runs. Most nodes respond to values of error in in a standard, predictable way.

error in does not contain an error error in contains an error
If no error occurred before the node runs, the node begins execution normally.

If no error occurs while the node runs, it returns no error. If an error does occur while the node runs, it returns that error information as error out.

If an error occurred before the node runs, the node does not execute. Instead, it returns the error in value as error out.

Where This Node Can Run:

Desktop OS: Windows

FPGA: Not supported

Web Server: Not supported in VIs that run in a web application