lsst.afw.display.interface.Display Class Reference

Inheritance diagram for lsst.afw.display.interface.Display:

Classes
class	_Buffering

Public Member Functions
def	__init__
	Create an object able to display images and overplot glyphs. More...
def	__enter__
	Support for python's with statement. More...
def	__exit__
	Support for python's with statement. More...
def	__del__
def	close
def	verbose
	The backend's verbosity. More...
def	verbose
def	__str__
def	maskColorGenerator
	A generator for "standard" colours. More...
def	setMaskPlaneColor
	Request that mask plane name be displayed as color. More...
def	getMaskPlaneColor
	Return the colour associated with the specified mask plane name. More...
def	setMaskTransparency
	Specify display's mask transparency (percent); or None to not set it when loading masks. More...
def	getMaskTransparency
	Return the current display's mask transparency. More...
def	show
	Uniconify and Raise display. More...
def	mtv
	Display an Image or Mask on a DISPLAY display. More...
def	Buffering
def	flush
	Flush the buffers. More...
def	erase
	Erase the specified DISPLAY frame. More...
def	dot
	Draw a symbol onto the specified DISPLAY frame at (col,row) = (c,r) [0-based coordinates]. More...
def	line
	Draw a set of symbols or connect the points, a list of (col,row) If symbs is True, draw points at the specified points using the desired symbol, otherwise connect the dots. More...
def	scale
	Set the range of the scaling from DN in the image to the image display. More...
def	zoom
	Zoom frame by specified amount, optionally panning also. More...
def	pan
	Pan to (rowc, colc); see also zoom. More...
def	interact
	Enter an interactive loop, listening for key presses in display and firing callbacks. More...
def	setCallback
	Set the callback for key k to be func, returning the old callback. More...
def	getActiveCallbackKeys
	Return all callback keys. More...

Static Public Member Functions
def	setDefaultBackend
def	getDefaultBackend
def	setDefaultFrame
def	getDefaultFrame
def	incrDefaultFrame
def	setDefaultMaskTransparency
def	setDefaultMaskPlaneColor
	Set the default mapping from mask plane names to colours. More...
def	getDisplay
	Return the Display indexed by frame, creating it if needs be. More...
def	delAllDisplays
	Delete and close all known display. More...

Public Attributes
	frame

Private Attributes
	_impl
	_xy0
	_maskPlaneColors
	_callbacks

Static Private Attributes
dictionary	_displays = {}
	_defaultBackend = None
int	_defaultFrame = 0
tuple	_defaultMaskPlaneColor
dictionary	_defaultMaskTransparency = {}

Detailed Description

Definition at line 87 of file interface.py.

Constructor & Destructor Documentation

def lsst.afw.display.interface.Display.__init__	(		self,
			frame,
			backend = None,
			args,
			kwargs
	)

Create an object able to display images and overplot glyphs.

Parameters

frame	An identifier for the display
backend	The backend to use (defaults to value set by setDefaultBackend())
args	Arguments to pass to the backend
kwargs	Arguments to pass to the backend

Definition at line 107 of file interface.py.

    def __init__(self, frame, backend=None, *args, **kwargs):
        """!Create an object able to display images and overplot glyphs

        \param frame An identifier for the display
        \param backend The backend to use (defaults to value set by setDefaultBackend())
        \param args Arguments to pass to the backend
        \param kwargs Arguments to pass to the backend
        """
        if backend is None:
            if Display._defaultBackend is None:
                try:
                    setDefaultBackend("ds9")
                except RuntimeError:
                    setDefaultBackend("virtualDevice")

            backend = Display._defaultBackend

        self.frame = frame
        self._impl = _makeDisplayImpl(self, backend, *args, **kwargs)

        self._xy0 = None                # the data displayed on the frame's XY0
        self.setMaskTransparency(Display._defaultMaskTransparency)
        self._maskPlaneColors = {}
        self.setMaskPlaneColor(Display._defaultMaskPlaneColor)

        self._callbacks = {}

        for ik in range(ord('a'), ord('z') + 1):
            k = "%c" % ik
            self.setCallback(k, noRaise=True)
            self.setCallback(k.upper(), noRaise=True)

        for k in ('Return', 'Shift_L', 'Shift_R'):
            self.setCallback(k)

        for k in ('q', 'Escape'):
            self.setCallback(k, lambda k, x, y: True)

        def _h_callback(k, x, y):
            h_callback(k, x, y)

            for k in sorted(self._callbacks.keys()):
                doc = self._callbacks[k].__doc__
                print "   %-6s %s" % (k, doc.split("\n")[0] if doc else "???")

        self.setCallback('h', _h_callback)