Classes | |
| class | Display |
| class | Event |
Functions | |
| _makeDisplayImpl (display, backend, *args, **kwargs) | |
| noop_callback (k, x, y) | |
| h_callback (k, x, y) | |
| setDefaultBackend (backend) | |
| getDefaultBackend () | |
| setDefaultFrame (frame=0) | |
| getDefaultFrame () | |
| incrDefaultFrame () | |
| setDefaultMaskTransparency (maskPlaneTransparency={}) | |
| setDefaultMaskPlaneColor (name=None, color=None) | |
| getDisplay (frame=None, backend=None, create=True, verbose=False, **kwargs) | |
| delAllDisplays () | |
Variables | |
| logger = logging.getLogger(__name__) | |
| str | WHITE = "white" |
| str | BLACK = "black" |
| str | RED = "red" |
| str | GREEN = "green" |
| str | BLUE = "blue" |
| str | CYAN = "cyan" |
| str | MAGENTA = "magenta" |
| str | YELLOW = "yellow" |
| str | ORANGE = "orange" |
| str | IGNORE = "ignore" |
Function Documentation
◆ _makeDisplayImpl()
|
protected |
Return the ``DisplayImpl`` for the named backend
Parameters
----------
display : `str`
Name of device. Should be importable, either absolutely or relative to lsst.display
backend : `str`
The desired backend
*args
Arguments passed to DisplayImpl.__init__
*kwargs
Keywords arguments passed to DisplayImpl.__init__
Examples
--------
E.g.
.. code-block:: py
import lsst.afw.display as afwDisplay
display = afwDisplay.Display(backend="ds9")
would call
.. code-block:: py
_makeDisplayImpl(..., "ds9", 1)
and import the ds9 implementation of ``DisplayImpl`` from `lsst.display.ds9`
Definition at line 53 of file interface.py.
53def _makeDisplayImpl(display, backend, *args, **kwargs):
54 """Return the ``DisplayImpl`` for the named backend
55
56 Parameters
57 ----------
58 display : `str`
59 Name of device. Should be importable, either absolutely or relative to lsst.display
60 backend : `str`
61 The desired backend
62 *args
63 Arguments passed to DisplayImpl.__init__
64 *kwargs
65 Keywords arguments passed to DisplayImpl.__init__
66
67 Examples
68 --------
69 E.g.
70
71 .. code-block:: py
72
73 import lsst.afw.display as afwDisplay
74 display = afwDisplay.Display(backend="ds9")
75
76 would call
77
78 .. code-block:: py
79
80 _makeDisplayImpl(..., "ds9", 1)
81
82 and import the ds9 implementation of ``DisplayImpl`` from `lsst.display.ds9`
83 """
84 _disp = None
85 exc = None
86 candidateBackends = (f"lsst.display.{backend}", backend, f".{backend}", f"lsst.afw.display.{backend}")
87 for dt in candidateBackends:
88 exc = None
89 # only specify the root package if we are not doing an absolute import
90 impargs = {}
91 if dt.startswith("."):
92 impargs["package"] = "lsst.display"
93 try:
94 _disp = importlib.import_module(dt, **impargs)
95 # If _disp doesn't have a DisplayImpl attribute, we probably
96 # picked up an irrelevant module due to a name collision
97 if hasattr(_disp, "DisplayImpl"):
98 break
99 else:
100 _disp = None
101 except (ImportError, SystemError) as e:
102 # SystemError can be raised in Python 3.5 if a relative import
103 # is attempted when the root package, lsst.display, does not exist.
104 # Copy the exception into outer scope
105 exc = e
106
107 if not _disp or not hasattr(_disp.DisplayImpl, "_show"):
108 # If available, re-use the final exception from above
109 e = ImportError(f"Could not load the requested backend: {backend} "
110 f"(tried {', '.join(candidateBackends)}, but none worked).")
111 if exc is not None:
112 raise e from exc
113 else:
114 raise e
115
116 if display:
117 _impl = _disp.DisplayImpl(display, *args, **kwargs)
118 if not hasattr(_impl, "frame"):
119 _impl.frame = display.frame
120
121 return _impl
122 else:
123 return True
124
125
◆ delAllDisplays()
| lsst.afw.display.interface.delAllDisplays | ( | ) |
Delete and close all known displays.
Definition at line 1004 of file interface.py.
1004def delAllDisplays():
1005 """Delete and close all known displays.
1006 """
1007 return Display.delAllDisplays()
◆ getDefaultBackend()
| lsst.afw.display.interface.getDefaultBackend | ( | ) |
Definition at line 939 of file interface.py.
939def getDefaultBackend():
940 return Display.getDefaultBackend()
941
942
◆ getDefaultFrame()
| lsst.afw.display.interface.getDefaultFrame | ( | ) |
Get the default frame for display.
Definition at line 947 of file interface.py.
947def getDefaultFrame():
948 """Get the default frame for display.
949 """
950 return Display.getDefaultFrame()
951
952
◆ getDisplay()
| lsst.afw.display.interface.getDisplay | ( | frame = None, | |
| backend = None, | |||
| create = True, | |||
| verbose = False, | |||
| ** | kwargs ) |
Return a specific `Display`, creating it if need be.
Parameters
----------
frame
Desired frame (`None` => use defaultFrame (see `setDefaultFrame`)).
backend : `str`
Create the specified frame using this backend (or the default if
`None`) if it doesn't already exist. If ``backend == ""``, it's an
error to specify a non-existent ``frame``.
create : `bool`
Create the display if it doesn't already exist.
verbose : `bool`
Allow backend to be chatty.
**kwargs
Keyword arguments passed to `Display` constructor.
See also
--------
Display.getDisplay
Definition at line 978 of file interface.py.
978def getDisplay(frame=None, backend=None, create=True, verbose=False, **kwargs):
979 """Return a specific `Display`, creating it if need be.
980
981 Parameters
982 ----------
983 frame
984 Desired frame (`None` => use defaultFrame (see `setDefaultFrame`)).
985 backend : `str`
986 Create the specified frame using this backend (or the default if
987 `None`) if it doesn't already exist. If ``backend == ""``, it's an
988 error to specify a non-existent ``frame``.
989 create : `bool`
990 Create the display if it doesn't already exist.
991 verbose : `bool`
992 Allow backend to be chatty.
993 **kwargs
994 Keyword arguments passed to `Display` constructor.
995
996 See also
997 --------
998 Display.getDisplay
999 """
1000
1001 return Display.getDisplay(frame, backend, create, verbose, **kwargs)
1002
1003
◆ h_callback()
| lsst.afw.display.interface.h_callback | ( | k, | |
| x, | |||
| y ) |
Definition at line 927 of file interface.py.
927def h_callback(k, x, y):
928 print("Enter q or <ESC> to leave interactive mode, h for this help, or a letter to fire a callback")
929 return False
930
931# Handle Displays, including the default one (the frame to use when a user specifies None)
932# If the default frame is None, image display is disabled
933
934
◆ incrDefaultFrame()
| lsst.afw.display.interface.incrDefaultFrame | ( | ) |
Increment the default frame for display.
Definition at line 953 of file interface.py.
953def incrDefaultFrame():
954 """Increment the default frame for display.
955 """
956 return Display.incrDefaultFrame()
957
958
◆ noop_callback()
| lsst.afw.display.interface.noop_callback | ( | k, | |
| x, | |||
| y ) |
Callback function Parameters ---------- key x y
Definition at line 915 of file interface.py.
915def noop_callback(k, x, y):
916 """Callback function
917
918 Parameters
919 ----------
920 key
921 x
922 y
923 """
924 return False
925
926
◆ setDefaultBackend()
| lsst.afw.display.interface.setDefaultBackend | ( | backend | ) |
Definition at line 935 of file interface.py.
935def setDefaultBackend(backend):
936 Display.setDefaultBackend(backend)
937
938
◆ setDefaultFrame()
| lsst.afw.display.interface.setDefaultFrame | ( | frame = 0 | ) |
Definition at line 943 of file interface.py.
943def setDefaultFrame(frame=0):
944 return Display.setDefaultFrame(frame)
945
946
◆ setDefaultMaskPlaneColor()
| lsst.afw.display.interface.setDefaultMaskPlaneColor | ( | name = None, | |
| color = None ) |
Set the default mapping from mask plane names to colors.
Parameters
----------
name : `str` or `dict`
Name of mask plane, or a dict mapping names to colors.
If ``name`` is `None`, use the hard-coded default dictionary.
color : `str`
Desired color, or `None` if ``name`` is a dict.
Definition at line 963 of file interface.py.
963def setDefaultMaskPlaneColor(name=None, color=None):
964 """Set the default mapping from mask plane names to colors.
965
966 Parameters
967 ----------
968 name : `str` or `dict`
969 Name of mask plane, or a dict mapping names to colors.
970 If ``name`` is `None`, use the hard-coded default dictionary.
971 color : `str`
972 Desired color, or `None` if ``name`` is a dict.
973 """
974
975 return Display.setDefaultMaskPlaneColor(name, color)
976
977
◆ setDefaultMaskTransparency()
| lsst.afw.display.interface.setDefaultMaskTransparency | ( | maskPlaneTransparency = {} | ) |
Definition at line 959 of file interface.py.
959def setDefaultMaskTransparency(maskPlaneTransparency={}):
960 return Display.setDefaultMaskTransparency(maskPlaneTransparency)
961
962
Variable Documentation
◆ BLACK
| str lsst.afw.display.interface.BLACK = "black" |
Definition at line 42 of file interface.py.
◆ BLUE
| str lsst.afw.display.interface.BLUE = "blue" |
Definition at line 45 of file interface.py.
◆ CYAN
| str lsst.afw.display.interface.CYAN = "cyan" |
Definition at line 46 of file interface.py.
◆ GREEN
| str lsst.afw.display.interface.GREEN = "green" |
Definition at line 44 of file interface.py.
◆ IGNORE
| str lsst.afw.display.interface.IGNORE = "ignore" |
Definition at line 50 of file interface.py.
◆ logger
| lsst.afw.display.interface.logger = logging.getLogger(__name__) |
Definition at line 38 of file interface.py.
◆ MAGENTA
| str lsst.afw.display.interface.MAGENTA = "magenta" |
Definition at line 47 of file interface.py.
◆ ORANGE
| str lsst.afw.display.interface.ORANGE = "orange" |
Definition at line 49 of file interface.py.
◆ RED
| str lsst.afw.display.interface.RED = "red" |
Definition at line 43 of file interface.py.
◆ WHITE
| str lsst.afw.display.interface.WHITE = "white" |
Definition at line 41 of file interface.py.
◆ YELLOW
| str lsst.afw.display.interface.YELLOW = "yellow" |
Definition at line 48 of file interface.py.
Generated on Wed Apr 23 2025 07:42:06 for LSST Applications by
1.13.2