RectangularROI¶

class glue.core.roi.RectangularROI(xmin=None, xmax=None, ymin=None, ymax=None)[source]¶

Bases: glue.core.roi.Roi

A 2D rectangular region of interest.

Methods Summary

`center`()
`contains`(x, y)	Test whether a set of (x,y) points falls within
`corner`()
`defined`()
`height`()
`move_to`(x, y)
`reset`()	Reset the rectangular region.
`to_polygon`()
`transpose`([copy])
`update_limits`(xmin, ymin, xmax, ymax)	Update the limits of the rectangle
`width`()

Methods Documentation

center()[source]¶

contains(x, y)[source]¶

Test whether a set of (x,y) points falls within the region of interest

Parameters:	x – A scalar or numpy array of x points y – A scalar or numpy array of y points

Returns

A list of True/False values, for whether each (x,y) point falls within the ROI

corner()[source]¶

defined()[source]¶

height()[source]¶

move_to(x, y)[source]¶

reset()[source]¶: Reset the rectangular region.

to_polygon()[source]¶

transpose(copy=True)[source]¶

update_limits(xmin, ymin, xmax, ymax)[source]¶: Update the limits of the rectangle

width()[source]¶