Skip to main content

RegionOfInterest

Represents a region of interest in an image.

Properties:

Property

Type

Description

x_offset

int

ROI top-left X offset

y_offset

int

ROI top-left Y offset

height

int

ROI height; 0 typically indicates full image

width

int

ROI width

do_rectify

bool

Whether to rectify the ROI

RegionOfInterest​

Signature:

RegionOfInterest(
x_offset: int = 0,
y_offset: int = 0,
height: int = 0,
width: int = 0,
do_rectify: bool = False,
)

Description:

Construct a RegionOfInterest instance.

Parameters:

Parameter

Type

Required

Description

x_offset

int

No

ROI top-left corner X offset

y_offset

int

No

ROI top-left corner Y offset

height

int

No

ROI height; 0 typically indicates full image

width

int

No

ROI width

do_rectify

bool

No

Whether to rectify the ROI

Returns:

RegionOfInterest instance.

Raises:

None.

to_dict​

Signature:

RegionOfInterest.to_dict() -> dict[str, Any]

Description:

Convert to dictionary.

Parameters:

No parameters.

Returns:

dict[str, Any].

Raises:

None.