Coverage for python/lsst/afw/display/ds9.py: 67%
57 statements
« prev ^ index » next coverage.py v6.4.2, created at 2022-08-04 02:31 -0700
« prev ^ index » next coverage.py v6.4.2, created at 2022-08-04 02:31 -0700
1# This file is part of afw.
2#
3# Developed for the LSST Data Management System.
4# This product includes software developed by the LSST Project
5# (https://www.lsst.org).
6# See the COPYRIGHT file at the top-level directory of this distribution
7# for details of code ownership.
8#
9# This program is free software: you can redistribute it and/or modify
10# it under the terms of the GNU General Public License as published by
11# the Free Software Foundation, either version 3 of the License, or
12# (at your option) any later version.
13#
14# This program is distributed in the hope that it will be useful,
15# but WITHOUT ANY WARRANTY; without even the implied warranty of
16# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17# GNU General Public License for more details.
18#
19# You should have received a copy of the GNU General Public License
20# along with this program. If not, see <https://www.gnu.org/licenses/>.
22import lsst.afw.display
23import lsst.afw.image as afwImage
24from .interface import getDisplay as _getDisplay, getDefaultBackend, setDefaultBackend
25# Backwards compatibility. Downstream code should be converted to use display.RED etc.
26from .interface import BLACK, RED, GREEN, BLUE, CYAN, MAGENTA, YELLOW, WHITE # noqa: F401
27try:
28 loaded
29except NameError:
30 try:
31 if getDefaultBackend() is None: 31 ↛ 33line 31 didn't jump to line 33, because the condition on line 31 was never false
32 setDefaultBackend("lsst.display.ds9")
33 getDisplay = _getDisplay
34 except Exception as e:
35 # No usable version of display_ds9.
36 # Let's define a version of getDisplay() which will throw an exception.
38 # Prior to DM-9433, we used a closure to implicitly capture the
39 # exception being thrown for future reference. Following changes to
40 # exception scope rules in Python 3 (see PEP 3110), it's now regarded
41 # as clearer to make the capture explicit using the following class.
42 class _RaiseException:
43 def __init__(self, exception):
44 # The exception being caught above may have a bulky context which we
45 # don't want to capture in a closure for all time: see DM-9504 for a
46 # full discussion. We therefore define a new exception of the same
47 # type, which just encodes the error text.
48 self.exception = type(exception)(f"{exception} (is display_ds9 setup?)")
50 def __call__(self, *args, **kwargs):
51 raise self.exception
53 getDisplay = _RaiseException(e)
55 class DisplayImpl:
56 __init__ = getDisplay
58 loaded = False
59 else:
60 loaded = True
63def Buffering():
64 # always use the real one
65 return _getDisplay(None, create=True).Buffering()
67#
68# Functions provided for backwards compatibility
69#
72def setMaskPlaneColor(name, color=None, frame=None):
73 return getDisplay(frame, create=True).setMaskPlaneColor(name, color)
76def getMaskPlaneColor(name, frame=None):
77 return getDisplay(frame, create=True).getMaskPlaneColor(name)
80def setMaskTransparency(name, frame=None):
81 return getDisplay(frame, create=True).setMaskTransparency(name)
84def getMaskTransparency(name, frame=None):
85 return getDisplay(frame, create=True).getMaskTransparency(name)
88def show(frame=None):
89 return getDisplay(frame, create=True).show()
92def mtv(data, frame=None, title="", wcs=None, *args, **kwargs):
93 return getDisplay(frame, create=True).mtv(data, title, wcs, *args, **kwargs)
96def erase(frame=None):
97 return getDisplay(frame, create=True).erase()
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)
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)
108def scale(algorithm, min, max=None, frame=None):
109 return getDisplay(frame, create=True).scale(algorithm, min, max)
112def pan(colc=None, rowc=None, frame=None, origin=afwImage.PARENT):
113 disp = getDisplay(frame, create=True)
115 disp.pan(colc, rowc, origin)
118def zoom(zoomfac=None, colc=None, rowc=None, frame=None, origin=afwImage.PARENT):
119 disp = getDisplay(frame, create=True)
121 disp.zoom(zoomfac)
122 disp.pan(colc, rowc, origin)
125def interact(frame=None):
126 return getDisplay(frame, create=True).interact()
129def setCallback(k, func=lsst.afw.display.noop_callback, noRaise=False, frame=None):
130 return getDisplay(frame, create=True).setCallback(k, noRaise=False)
133def getActiveCallbackKeys(onlyActive=True, frame=None):
134 return getDisplay(frame, create=True).getActiveCallbackKeys(onlyActive)