xil_get_roi(3)

NAME

xil_get_roi, xil_set_roi − get or set an image’s ROI

SYNOPSIS

#include <xil/xil.h>

XilRoi xil_get_roi ( XilImage image);

void xil_set_roi ( XilImage image,

XilRoi roi);

DESCRIPTION

These functions get and set the region of interest (ROI) associated with an image.

xil_get_roi() returns a copy of the ROI associated with the specified image.

xil_set_roi() sets the ROI associated with the specified image to the one supplied.

ROI Behavior

An efficient way to specify an ROI that encompasses an entire image is to set the image’s ROI to NULL.

ERRORS

For a complete list of XIL error messages by number, consult Appendix B of the XIL Programmer’s Guide.

EXAMPLES

Get the ROI associated with an image, remove a rectangular region from the ROI, and replace the image’s ROI with the modified one. Then destroy the ROI:

XilSystemState State;
XilImage image;
XilRoi roi;
roi = xil_get_roi (image);
if (roi == NULL) {
    /∗ The image had no ROI associated with it,
       create one that encompasses the whole image ∗/
    roi = xil_roi_create (State);
    xil_roi_add_rect (roi, 0, 0, xil_get_width(image), xil_get_height(image));
}
xil_roi_subtract_rect (roi, 10, 10, 20, 20);
xil_set_roi (image, roi);
xil_roi_destroy (roi);

Museum

Related Articles