confocalgui.CrossROI Class Reference

Create a Region of interest, which is a zoomable rectangular. More...

Inheritance diagram for confocalgui.CrossROI:

Collaboration diagram for confocalgui.CrossROI:

Public Member Functions
def	__init__ (self, pos, size, args)
	Create a ROI with a central handle. More...
def	setPos (self, pos, update=True, finish=False)
	Sets the position of the ROI. More...
def	setSize (self, size, update=True, finish=True)
	Sets the size of the ROI. More...
def	handleMoveStarted (self)
	Handles should always be moved by user. More...
def	startUserDrag (self, roi)
	ROI has started being dragged by user. More...
def	stopUserDrag (self, roi)
	ROI has stopped being dragged by use.
def	regionUpdateInfo (self, roi)
	When the region is being dragged by the user, emit the corresponding signal. More...

Public Attributes
	userDrag

Static Public Attributes
	sigUserRegionUpdate = QtCore.Signal(object)
	sigMachineRegionUpdate = QtCore.Signal(object)

Detailed Description

Create a Region of interest, which is a zoomable rectangular.

Parameters

float	pos: optional parameter to set the position
float	size: optional parameter to set the size of the roi

Have a look at: http://www.pyqtgraph.org/documentation/graphicsItems/roi.html

Constructor & Destructor Documentation

__init__()

def confocalgui.CrossROI.__init__	(		self,
			pos,
			size,
			args
	)

Create a ROI with a central handle.

Member Function Documentation

handleMoveStarted()

def confocalgui.CrossROI.handleMoveStarted

(

self

)

Handles should always be moved by user.

regionUpdateInfo()

def confocalgui.CrossROI.regionUpdateInfo	(		self,
			roi
	)

When the region is being dragged by the user, emit the corresponding signal.

setPos()

def confocalgui.CrossROI.setPos	(		self,
			pos,
			update = True,
			finish = False
	)

Sets the position of the ROI.

Parameters

bool	update: whether to update the display for this call of setPos
bool	finish: whether to emit sigRegionChangeFinished

Changed finish from parent class implementation to not disrupt user dragging detection.

setSize()

def confocalgui.CrossROI.setSize	(		self,
			size,
			update = True,
			finish = True
	)

Sets the size of the ROI.

Parameters

bool	update: whether to update the display for this call of setPos
bool	finish: whether to emit sigRegionChangeFinished

startUserDrag()

def confocalgui.CrossROI.startUserDrag	(		self,
			roi
	)

ROI has started being dragged by user.

---

The documentation for this class was generated from the following file:

• gui/confocal/confocalgui.py