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(self)

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

contains(self, x, y)

Return true/false for each x/y pair.

contains3d(self, x, y, z)

Return true/false for each x/y/z pair.

copy(self)

Return a clone of the ROI

defined(self)

Returns whether or not the subset is properly defined

move_to(self, x, y)

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

to_polygon(self)

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

transformed(self[, xfunc, yfunc])

A transformed version of the ROI

Methods Documentation

center(self)[source]

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

contains(self, x, y)[source]

Return true/false for each x/y pair.

Parameters
  • x – Array of X locations

  • y – Array of Y locations

Returns

A Boolean array, where each element is True if the corresponding (x,y) tuple is inside the Roi.

Raises

UndefinedROI exception if not defined

contains3d(self, x, y, z)[source]

Return true/false for each x/y/z pair.

Parameters
xnumpy.ndarray

Array of x locations

ynumpy.ndarray

Array of y locations

znumpy.ndarray

Array of z locations

Returns
numpy.ndarray

A boolean array, where each element is True if the corresponding (x,y,z) tuple is inside the Roi.

Raises
UndefinedROI

if not defined

copy(self)[source]

Return a clone of the ROI

defined(self)[source]

Returns whether or not the subset is properly defined

move_to(self, x, y)[source]

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

to_polygon(self)[source]

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

transformed(self, xfunc=None, yfunc=None)[source]

A transformed version of the ROI