LSST Applications g2079a07aa2+86d27d4dc4,g2305ad1205+a659bff248,g2bbee38e9b+3c60f8fe34,g337abbeb29+3c60f8fe34,g33d1c0ed96+3c60f8fe34,g3502564af9+d77d6d1350,g3a166c0a6a+3c60f8fe34,g487adcacf7+25d9892218,g4be5004598+d77d6d1350,g50ff169b8f+96c6868917,g52b1c1532d+585e252eca,g591dd9f2cf+4d81263f9a,g5cd07815a0+980d2b1c3b,g607f77f49a+d77d6d1350,g858d7b2824+d77d6d1350,g88963caddf+83e433e629,g99cad8db69+a4d3c48eeb,g9ddcbc5298+9a081db1e4,ga1e77700b3+bcf1af89ad,ga57fefb910+9a39d7b2d7,gae0086650b+585e252eca,gb065fddaf9+4f9fd82a2c,gb0e22166c9+60f28cb32d,gb363559e06+d84b1d3d07,gb3b7280ab2+4563d032e1,gb4b16eec92+babe958938,gba4ed39666+c2a2e4ac27,gbb8dafda3b+ed6854b564,gc120e1dc64+b72d212f87,gc28159a63d+3c60f8fe34,gc3e9b769f7+921dbcd359,gcf0d15dbbd+9a39d7b2d7,gdaeeff99f8+f9a426f77a,gddc38dedce+585e252eca,ge79ae78c31+3c60f8fe34,w.2024.21
LSST Data Management Base Package
Loading...
Searching...
No Matches
ds9.py
Go to the documentation of this file.
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/>.
21
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:
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.
37
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.
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?)")
49
50 def __call__(self, *args, **kwargs):
51 raise self.exception
52
53 getDisplay = _RaiseException(e)
54
56 __init__ = getDisplay
57
58 loaded = False
59 else:
60 loaded = True
61
62
64 # always use the real one
65 return _getDisplay(None, create=True).Buffering()
66
67#
68# Functions provided for backwards compatibility
69#
70
71
72def setMaskPlaneColor(name, color=None, frame=None):
73 return getDisplay(frame, create=True).setMaskPlaneColor(name, color)
74
75
76def getMaskPlaneColor(name, frame=None):
77 return getDisplay(frame, create=True).getMaskPlaneColor(name)
78
79
80def setMaskTransparency(name, frame=None):
81 return getDisplay(frame, create=True).setMaskTransparency(name)
82
83
84def getMaskTransparency(name, frame=None):
85 return getDisplay(frame, create=True).getMaskTransparency(name)
86
87
88def show(frame=None):
89 return getDisplay(frame, create=True).show()
90
91
92def mtv(data, frame=None, title="", wcs=None, *args, **kwargs):
93 return getDisplay(frame, create=True).mtv(data, title, wcs, *args, **kwargs)
94
95
96def erase(frame=None):
97 return getDisplay(frame, create=True).erase()
98
99
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
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
108def scale(algorithm, min, max=None, frame=None):
109 return getDisplay(frame, create=True).scale(algorithm, min, max)
110
111
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
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
125def interact(frame=None):
126 return getDisplay(frame, create=True).interact()
127
128
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
133def getActiveCallbackKeys(onlyActive=True, frame=None):
134 return getDisplay(frame, create=True).getActiveCallbackKeys(onlyActive)
__call__(self, *args, **kwargs)
Definition ds9.py:50
dot(symb, c, r, frame=None, size=2, ctype=None, origin=afwImage.PARENT, *args, **kwargs)
Definition ds9.py:100
interact(frame=None)
Definition ds9.py:125
setMaskTransparency(name, frame=None)
Definition ds9.py:80
setMaskPlaneColor(name, color=None, frame=None)
Definition ds9.py:72
getActiveCallbackKeys(onlyActive=True, frame=None)
Definition ds9.py:133
getMaskPlaneColor(name, frame=None)
Definition ds9.py:76
pan(colc=None, rowc=None, frame=None, origin=afwImage.PARENT)
Definition ds9.py:112
mtv(data, frame=None, title="", wcs=None, *args, **kwargs)
Definition ds9.py:92
scale(algorithm, min, max=None, frame=None)
Definition ds9.py:108
getMaskTransparency(name, frame=None)
Definition ds9.py:84
line(points, frame=None, origin=afwImage.PARENT, symbs=False, ctype=None, size=0.5)
Definition ds9.py:104
zoom(zoomfac=None, colc=None, rowc=None, frame=None, origin=afwImage.PARENT)
Definition ds9.py:118
setCallback(k, func=lsst.afw.display.noop_callback, noRaise=False, frame=None)
Definition ds9.py:129
show(frame=None)
Definition ds9.py:88
erase(frame=None)
Definition ds9.py:96