PolygonalROI

class glue.core.roi.PolygonalROI(vx=None, vy=None)[source]

Bases: glue.core.roi.VertexROIBase

A class to define 2D polygonal regions-of-interest

Parameters
  • vx (list) – initial x vertices

  • vy (list) – initial y vertices

Methods Summary

contains(self, x, y)

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

move_to(self, xdelta, ydelta)

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

Methods Documentation

contains(self, x, y)[source]

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

Parameters
  • x – A list of x points

  • y – A list of y points

Returns

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

move_to(self, xdelta, ydelta)[source]

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