LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
Classes | Functions | Variables
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 63 of file ds9.py.

63 def 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 
def Buffering()
Definition: ds9.py:63

◆ 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 100 of file ds9.py.

100 def 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 
def dot(symb, c, r, frame=None, size=2, ctype=None, origin=afwImage.PARENT, *args, **kwargs)
Definition: ds9.py:100

◆ erase()

def lsst.afw.display.ds9.erase (   frame = None)
Examples
forEachPixel.cc.

Definition at line 96 of file ds9.py.

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

◆ getActiveCallbackKeys()

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

Definition at line 133 of file ds9.py.

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

◆ getMaskPlaneColor()

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

Definition at line 76 of file ds9.py.

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

◆ getMaskTransparency()

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

Definition at line 84 of file ds9.py.

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

◆ interact()

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

Definition at line 125 of file ds9.py.

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

◆ line()

def 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.

104 def 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 
def line(points, frame=None, origin=afwImage.PARENT, symbs=False, ctype=None, size=0.5)
Definition: ds9.py:104

◆ mtv()

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

Definition at line 92 of file ds9.py.

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

◆ pan()

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

Definition at line 112 of file ds9.py.

112 def 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 
def pan(colc=None, rowc=None, frame=None, origin=afwImage.PARENT)
Definition: ds9.py:112

◆ scale()

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

Definition at line 108 of file ds9.py.

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

◆ setCallback()

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

Definition at line 129 of file ds9.py.

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

◆ setMaskPlaneColor()

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

Definition at line 72 of file ds9.py.

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

◆ setMaskTransparency()

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

Definition at line 80 of file ds9.py.

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

◆ show()

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

Definition at line 88 of file ds9.py.

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

◆ zoom()

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

Definition at line 118 of file ds9.py.

118 def 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 
def zoom(zoomfac=None, colc=None, rowc=None, frame=None, origin=afwImage.PARENT)
Definition: ds9.py:118

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.