Loading [MathJax]/extensions/tex2jax.js
LSST Applications g04a91732dc+a777afbe81,g07dc498a13+7e3c5f68a2,g12483e3c20+0145ec33cd,g1409bbee79+7e3c5f68a2,g1a7e361dbc+7e3c5f68a2,g1fd858c14a+9f35e23ec3,g35bb328faa+fcb1d3bbc8,g3ad4f90e5c+0145ec33cd,g3bd4b5ce2c+cbf1bea503,g4e0f332c67+5d362be553,g53246c7159+fcb1d3bbc8,g5477a8d5ce+db04660fe6,g60b5630c4e+0145ec33cd,g623d845a50+0145ec33cd,g6f0c2978f1+3526b51a37,g75b6c65c88+d54b601591,g78460c75b0+2f9a1b4bcd,g786e29fd12+cf7ec2a62a,g7b71ed6315+fcb1d3bbc8,g8852436030+4639f750a5,g89139ef638+7e3c5f68a2,g9125e01d80+fcb1d3bbc8,g919ac25b3e+6220c5324a,g95236ca021+f7a31438ed,g989de1cb63+7e3c5f68a2,g9f33ca652e+2d6fa11d35,gaaedd4e678+7e3c5f68a2,gabe3b4be73+1e0a283bba,gb1101e3267+4a428ef779,gb4a253aaf5+0122250889,gb58c049af0+f03b321e39,gc99c83e5f0+76d20ab76d,gcf25f946ba+4639f750a5,gd6cbbdb0b4+c8606af20c,gde0f65d7ad+3d8a3b7e46,ge278dab8ac+932305ba37,gf795337580+03b96afe58,gfba249425e+fcb1d3bbc8,w.2025.08
LSST Data Management Base Package
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
lsst.afw.display.ds9 Namespace Reference

Classes

class  _RaiseException
 
class  DisplayImpl
 

Functions

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

Variables

 getDisplay = _getDisplay
 
 loaded = True
 

Function Documentation

◆ Buffering()

lsst.afw.display.ds9.Buffering ( )

Definition at line 63 of file ds9.py.

63def Buffering():
64 # always use the real one
65 return _getDisplay(None, create=True).Buffering()
66
67#
68# Functions provided for backwards compatibility
69#
70
71

◆ dot()

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

Definition at line 100 of file ds9.py.

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

◆ erase()

lsst.afw.display.ds9.erase ( frame = None)

Definition at line 96 of file ds9.py.

96def erase(frame=None):
97 return getDisplay(frame, create=True).erase()
98
99

◆ getActiveCallbackKeys()

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

Definition at line 133 of file ds9.py.

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

◆ getMaskPlaneColor()

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

Definition at line 76 of file ds9.py.

76def getMaskPlaneColor(name, frame=None):
77 return getDisplay(frame, create=True).getMaskPlaneColor(name)
78
79

◆ getMaskTransparency()

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

Definition at line 84 of file ds9.py.

84def getMaskTransparency(name, frame=None):
85 return getDisplay(frame, create=True).getMaskTransparency(name)
86
87

◆ interact()

lsst.afw.display.ds9.interact ( frame = None)

Definition at line 125 of file ds9.py.

125def interact(frame=None):
126 return getDisplay(frame, create=True).interact()
127
128

◆ line()

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

Definition at line 104 of file ds9.py.

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

◆ mtv()

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

Definition at line 92 of file ds9.py.

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

◆ pan()

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

Definition at line 112 of file ds9.py.

112def pan(colc=None, rowc=None, frame=None, origin=afwImage.PARENT):
113 disp = getDisplay(frame, create=True)
114
115 disp.pan(colc, rowc, origin)
116
117

◆ scale()

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

Definition at line 108 of file ds9.py.

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

◆ setCallback()

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

Definition at line 129 of file ds9.py.

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

◆ setMaskPlaneColor()

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

Definition at line 72 of file ds9.py.

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

◆ setMaskTransparency()

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

Definition at line 80 of file ds9.py.

80def setMaskTransparency(name, frame=None):
81 return getDisplay(frame, create=True).setMaskTransparency(name)
82
83

◆ show()

lsst.afw.display.ds9.show ( frame = None)

Definition at line 88 of file ds9.py.

88def show(frame=None):
89 return getDisplay(frame, create=True).show()
90
91

◆ zoom()

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

Definition at line 118 of file ds9.py.

118def zoom(zoomfac=None, colc=None, rowc=None, frame=None, origin=afwImage.PARENT):
119 disp = getDisplay(frame, create=True)
120
121 disp.zoom(zoomfac)
122 disp.pan(colc, rowc, origin)
123
124

Variable Documentation

◆ getDisplay

lsst.afw.display.ds9.getDisplay = _getDisplay

Definition at line 33 of file ds9.py.

◆ loaded

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

Definition at line 58 of file ds9.py.