# Roi¶

class glue.core.roi.Roi[source]

Bases: object

A geometrical 2D region of interest.

Glue uses Roi’s to represent user-drawn regions on plots. There are many specific subtypes of Roi, but they all have a contains method to test whether a collection of 2D points lies inside the region.

Methods Summary

 center() Return the (x,y) coordinates of the ROI center contains(x, y) Return true/false for each x/y pair. copy() Return a clone of the ROI defined() Returns whether or not the subset is properly defined move_to(x, y) Translate the ROI to a center of (x, y) to_polygon() Returns a tuple of x and y points, approximating the ROI as a polygon.

Methods Documentation

center()[source]

Return the (x,y) coordinates of the ROI center

contains(x, y)[source]

Return true/false for each x/y pair.

Parameters: x – Array of X locations y – Array of Y locations A Boolean array, where each element is True if the corresponding (x,y) tuple is inside the Roi. UndefinedROI exception if not defined
copy()[source]

Return a clone of the ROI

defined()[source]

Returns whether or not the subset is properly defined

move_to(x, y)[source]

Translate the ROI to a center of (x, y)

to_polygon()[source]

Returns a tuple of x and y points, approximating the ROI as a polygon.