lsst.afw.display.ds9 Namespace Reference

Classes
class	_RaiseException
class	DisplayImpl

Functions
def	Buffering ()
def	setMaskPlaneColor (name, color=None, frame=None)
def	getMaskPlaneColor (name, frame=None)
def	setMaskTransparency (name, frame=None)
def	getMaskTransparency (name, frame=None)
def	show (frame=None)
def	mtv (data, frame=None, title="", wcs=None, *args, **kwargs)
def	erase (frame=None)
def	dot (symb, c, r, frame=None, size=2, ctype=None, origin=afwImage.PARENT, *args, **kwargs)
def	line (points, frame=None, origin=afwImage.PARENT, symbs=False, ctype=None, size=0.5)
def	scale (algorithm, min, max=None, frame=None)
def	pan (colc=None, rowc=None, frame=None, origin=afwImage.PARENT)
def	zoom (zoomfac=None, colc=None, rowc=None, frame=None, origin=afwImage.PARENT)
def	interact (frame=None)
def	setCallback (k, func=lsst.afw.display.noop_callback, noRaise=False, frame=None)
def	getActiveCallbackKeys (onlyActive=True, frame=None)

Variables
	getDisplay = _getDisplay
	loaded = True

Function Documentation

Buffering()

def lsst.afw.display.ds9.Buffering

(

)

Definition at line 64 of file ds9.py.

def Buffering():
    # always use the real one
    return _getDisplay(None, create=True).Buffering()
 
#
# Functions provided for backwards compatibility
#
 
 

dot()

def lsst.afw.display.ds9.dot	(		symb,
			c,
			r,
			frame = None,
			size = 2,
			ctype = None,
			origin = afwImage.PARENT,
		*	args,
		**	kwargs
	)

Examples

image2.cc, and maskedImage2.cc.

Definition at line 101 of file ds9.py.

def dot(symb, c, r, frame=None, size=2, ctype=None, origin=afwImage.PARENT, *args, **kwargs):
    return getDisplay(frame, create=True).dot(symb, c, r, size, ctype, origin, *args, **kwargs)
 
 

erase()

def lsst.afw.display.ds9.erase

(

frame = None

)

Examples

forEachPixel.cc.

Definition at line 97 of file ds9.py.

def erase(frame=None):
    return getDisplay(frame, create=True).erase()
 
 

getActiveCallbackKeys()

def lsst.afw.display.ds9.getActiveCallbackKeys	(		onlyActive = True,
			frame = None
	)

Definition at line 134 of file ds9.py.

def getActiveCallbackKeys(onlyActive=True, frame=None):
    return getDisplay(frame, create=True).getActiveCallbackKeys(onlyActive)

getMaskPlaneColor()

def lsst.afw.display.ds9.getMaskPlaneColor	(		name,
			frame = None
	)

Definition at line 77 of file ds9.py.

def getMaskPlaneColor(name, frame=None):
    return getDisplay(frame, create=True).getMaskPlaneColor(name)
 
 

getMaskTransparency()

def lsst.afw.display.ds9.getMaskTransparency	(		name,
			frame = None
	)

Definition at line 85 of file ds9.py.

def getMaskTransparency(name, frame=None):
    return getDisplay(frame, create=True).getMaskTransparency(name)
 
 

interact()

def lsst.afw.display.ds9.interact

(

frame = None

)

Definition at line 126 of file ds9.py.

def interact(frame=None):
    return getDisplay(frame, create=True).interact()
 
 

line()

def lsst.afw.display.ds9.line	(		points,
			frame = None,
			origin = afwImage.PARENT,
			symbs = False,
			ctype = None,
			size = 0.5
	)

Definition at line 105 of file ds9.py.

def line(points, frame=None, origin=afwImage.PARENT, symbs=False, ctype=None, size=0.5):
    return getDisplay(frame, create=True).line(points, origin, symbs, ctype, size)
 
 

mtv()

def lsst.afw.display.ds9.mtv	(		data,
			frame = None,
			title = "",
			wcs = None,
		*	args,
		**	kwargs
	)

Definition at line 93 of file ds9.py.

def mtv(data, frame=None, title="", wcs=None, *args, **kwargs):
    return getDisplay(frame, create=True).mtv(data, title, wcs, *args, **kwargs)
 
 

pan()

def lsst.afw.display.ds9.pan	(		colc = None,
			rowc = None,
			frame = None,
			origin = afwImage.PARENT
	)

Definition at line 113 of file ds9.py.

def pan(colc=None, rowc=None, frame=None, origin=afwImage.PARENT):
    disp = getDisplay(frame, create=True)
 
    disp.pan(colc, rowc, origin)
 
 

scale()

def lsst.afw.display.ds9.scale	(		algorithm,
			min,
			max = None,
			frame = None
	)

Definition at line 109 of file ds9.py.

def scale(algorithm, min, max=None, frame=None):
    return getDisplay(frame, create=True).scale(algorithm, min, max)
 
 

setCallback()

def lsst.afw.display.ds9.setCallback	(		k,
			func = lsst.afw.display.noop_callback,
			noRaise = False,
			frame = None
	)

Definition at line 130 of file ds9.py.

def setCallback(k, func=lsst.afw.display.noop_callback, noRaise=False, frame=None):
    return getDisplay(frame, create=True).setCallback(k, noRaise=False)
 
 

setMaskPlaneColor()

def lsst.afw.display.ds9.setMaskPlaneColor	(		name,
			color = None,
			frame = None
	)

Definition at line 73 of file ds9.py.

def setMaskPlaneColor(name, color=None, frame=None):
    return getDisplay(frame, create=True).setMaskPlaneColor(name, color)
 
 

setMaskTransparency()

def lsst.afw.display.ds9.setMaskTransparency	(		name,
			frame = None
	)

Definition at line 81 of file ds9.py.

def setMaskTransparency(name, frame=None):
    return getDisplay(frame, create=True).setMaskTransparency(name)
 
 

show()

def lsst.afw.display.ds9.show

(

frame = None

)

Definition at line 89 of file ds9.py.

def show(frame=None):
    return getDisplay(frame, create=True).show()
 
 

zoom()

def lsst.afw.display.ds9.zoom	(		zoomfac = None,
			colc = None,
			rowc = None,
			frame = None,
			origin = afwImage.PARENT
	)

Definition at line 119 of file ds9.py.

def zoom(zoomfac=None, colc=None, rowc=None, frame=None, origin=afwImage.PARENT):
    disp = getDisplay(frame, create=True)
 
    disp.zoom(zoomfac)
    disp.pan(colc, rowc, origin)
 
 

Variable Documentation

getDisplay

lsst.afw.display.ds9.getDisplay = _getDisplay

Definition at line 34 of file ds9.py.

loaded

bool lsst.afw.display.ds9.loaded = True

Definition at line 59 of file ds9.py.