LSSTApplications  18.0.0+67,19.0.0+5,19.0.0+54,19.0.0+57,19.0.0+63,19.0.0+9,19.0.0-1-g20d9b18+23,19.0.0-1-g49a97f9+3,19.0.0-1-g5549ca4+4,19.0.0-1-g8c57eb9+23,19.0.0-1-g8e6e14c+13,19.0.0-1-ga72da6b+3,19.0.0-1-gbfe0924+50,19.0.0-1-ge272bc4+23,19.0.0-1-gefe1d0d+36,19.0.0-11-g57ef05f+1,19.0.0-13-g8db0348+4,19.0.0-14-g706b86db4+1,19.0.0-14-ge428dae,19.0.0-15-g557baf8+8,19.0.0-16-gdc8ce7c+1,19.0.0-2-g0d9f9cd+59,19.0.0-2-g260436e+40,19.0.0-2-g9675b69+3,19.0.0-2-g9b11441+48,19.0.0-2-gde8e5e3+3,19.0.0-2-gf01c5b1+1,19.0.0-2-gff6972b+7,19.0.0-3-g27e4659+25,19.0.0-3-g6513920+52,19.0.0-4-gac56cce+1,19.0.0-41-g13db8fbc+1,19.0.0-43-gbcf6a3c,19.0.0-6-gdd6eb13,19.0.0-7-g686a884+4,19.0.0-9-gce87a591+7,w.2020.14
LSSTDataManagementBasePackage
ds9.py
Go to the documentation of this file.
1 #
2 # LSST Data Management System
3 # Copyright 2008, 2009, 2010, 2015 LSST Corporation.
4 #
5 # This product includes software developed by the
6 # LSST Project (http://www.lsst.org/).
7 #
8 # This program is free software: you can redistribute it and/or modify
9 # it under the terms of the GNU General Public License as published by
10 # the Free Software Foundation, either version 3 of the License, or
11 # (at your option) any later version.
12 #
13 # This program is distributed in the hope that it will be useful,
14 # but WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
17 #
18 # You should have received a copy of the LSST License Statement and
19 # the GNU General Public License along with this program. If not,
20 # see <http://www.lsstcorp.org/LegalNotices/>.
21 #
22 
23 import lsst.afw.display
24 import lsst.afw.image as afwImage
25 from .interface import getDisplay as _getDisplay, getDefaultBackend, setDefaultBackend
26 # Backwards compatibility. Downstream code should be converted to use display.RED etc.
27 from .interface import BLACK, RED, GREEN, BLUE, CYAN, MAGENTA, YELLOW, WHITE # noqa: F401
28 try:
29  loaded
30 except NameError:
31  try:
32  if getDefaultBackend() is None:
33  setDefaultBackend("lsst.display.ds9")
34  getDisplay = _getDisplay
35  except Exception as e:
36  # No usable version of display_ds9.
37  # Let's define a version of getDisplay() which will throw an exception.
38 
39  # Prior to DM-9433, we used a closure to implicitly capture the
40  # exception being thrown for future reference. Following changes to
41  # exception scope rules in Python 3 (see PEP 3110), it's now regarded
42  # as clearer to make the capture explicit using the following class.
44  def __init__(self, exception):
45  # The exception being caught above may have a bulky context which we
46  # don't want to capture in a closure for all time: see DM-9504 for a
47  # full discussion. We therefore define a new exception of the same
48  # type, which just encodes the error text.
49  self.exception = type(exception)(f"{exception} (is display_ds9 setup?)")
50 
51  def __call__(self, *args, **kwargs):
52  raise self.exception
53 
54  getDisplay = _RaiseException(e)
55 
56  class DisplayImpl:
57  __init__ = getDisplay
58 
59  loaded = False
60  else:
61  loaded = True
62 
63 
64 def Buffering():
65  # always use the real one
66  return _getDisplay(None, create=True).Buffering()
67 
68 #
69 # Functions provided for backwards compatibility
70 #
71 
72 
73 def setMaskPlaneColor(name, color=None, frame=None):
74  return getDisplay(frame, create=True).setMaskPlaneColor(name, color)
75 
76 
77 def getMaskPlaneColor(name, frame=None):
78  return getDisplay(frame, create=True).getMaskPlaneColor(name)
79 
80 
81 def setMaskTransparency(name, frame=None):
82  return getDisplay(frame, create=True).setMaskTransparency(name)
83 
84 
85 def getMaskTransparency(name, frame=None):
86  return getDisplay(frame, create=True).getMaskTransparency(name)
87 
88 
89 def show(frame=None):
90  return getDisplay(frame, create=True).show()
91 
92 
93 def mtv(data, frame=None, title="", wcs=None, *args, **kwargs):
94  return getDisplay(frame, create=True).mtv(data, title, wcs, *args, **kwargs)
95 
96 
97 def erase(frame=None):
98  return getDisplay(frame, create=True).erase()
99 
100 
101 def dot(symb, c, r, frame=None, size=2, ctype=None, origin=afwImage.PARENT, *args, **kwargs):
102  return getDisplay(frame, create=True).dot(symb, c, r, size, ctype, origin, *args, **kwargs)
103 
104 
105 def line(points, frame=None, origin=afwImage.PARENT, symbs=False, ctype=None, size=0.5):
106  return getDisplay(frame, create=True).line(points, origin, symbs, ctype, size)
107 
108 
109 def scale(algorithm, min, max=None, frame=None):
110  return getDisplay(frame, create=True).scale(algorithm, min, max)
111 
112 
113 def pan(colc=None, rowc=None, frame=None, origin=afwImage.PARENT):
114  disp = getDisplay(frame, create=True)
115 
116  disp.pan(colc, rowc, origin)
117 
118 
119 def zoom(zoomfac=None, colc=None, rowc=None, frame=None, origin=afwImage.PARENT):
120  disp = getDisplay(frame, create=True)
121 
122  disp.zoom(zoomfac)
123  disp.pan(colc, rowc, origin)
124 
125 
126 def interact(frame=None):
127  return getDisplay(frame, create=True).interact()
128 
129 
130 def setCallback(k, func=lsst.afw.display.noop_callback, noRaise=False, frame=None):
131  return getDisplay(frame, create=True).setCallback(k, noRaise=False)
132 
133 
134 def getActiveCallbackKeys(onlyActive=True, frame=None):
135  return getDisplay(frame, create=True).getActiveCallbackKeys(onlyActive)
def erase(frame=None)
Definition: ds9.py:97
def __init__(self, exception)
Definition: ds9.py:44
def getActiveCallbackKeys(onlyActive=True, frame=None)
Definition: ds9.py:134
def scale(algorithm, min, max=None, frame=None)
Definition: ds9.py:109
def setMaskTransparency(name, frame=None)
Definition: ds9.py:81
def __call__(self, args, kwargs)
Definition: ds9.py:51
def dot(symb, c, r, frame=None, size=2, ctype=None, origin=afwImage.PARENT, args, kwargs)
Definition: ds9.py:101
def pan(colc=None, rowc=None, frame=None, origin=afwImage.PARENT)
Definition: ds9.py:113
def show(frame=None)
Definition: ds9.py:89
def zoom(zoomfac=None, colc=None, rowc=None, frame=None, origin=afwImage.PARENT)
Definition: ds9.py:119
table::Key< int > type
Definition: Detector.cc:163
def setDefaultBackend(backend)
Definition: interface.py:870
def mtv(data, frame=None, title="", wcs=None, args, kwargs)
Definition: ds9.py:93
def line(points, frame=None, origin=afwImage.PARENT, symbs=False, ctype=None, size=0.5)
Definition: ds9.py:105
def setCallback(k, func=lsst.afw.display.noop_callback, noRaise=False, frame=None)
Definition: ds9.py:130
def getMaskPlaneColor(name, frame=None)
Definition: ds9.py:77
def getMaskTransparency(name, frame=None)
Definition: ds9.py:85
def setMaskPlaneColor(name, color=None, frame=None)
Definition: ds9.py:73
def Buffering()
Definition: ds9.py:64
Backwards-compatibility support for depersisting the old Calib (FluxMag0/FluxMag0Err) objects...
def interact(frame=None)
Definition: ds9.py:126