LSST Applications g042eb84c57+730a74494b,g04e9c324dd+8c5ae1fdc5,g134cb467dc+1f1e3e7524,g199a45376c+0ba108daf9,g1fd858c14a+fa7d31856b,g210f2d0738+f66ac109ec,g262e1987ae+83a3acc0e5,g29ae962dfc+d856a2cb1f,g2cef7863aa+aef1011c0b,g35bb328faa+8c5ae1fdc5,g3fd5ace14f+a1e0c9f713,g47891489e3+0d594cb711,g4d44eb3520+c57ec8f3ed,g4d7b6aa1c5+f66ac109ec,g53246c7159+8c5ae1fdc5,g56a1a4eaf3+fd7ad03fde,g64539dfbff+f66ac109ec,g67b6fd64d1+0d594cb711,g67fd3c3899+f66ac109ec,g6985122a63+0d594cb711,g74acd417e5+3098891321,g786e29fd12+668abc6043,g81db2e9a8d+98e2ab9f28,g87389fa792+8856018cbb,g89139ef638+0d594cb711,g8d7436a09f+80fda9ce03,g8ea07a8fe4+760ca7c3fc,g90f42f885a+033b1d468d,g97be763408+a8a29bda4b,g99822b682c+e3ec3c61f9,g9d5c6a246b+0d5dac0c3d,ga41d0fce20+9243b26dd2,gbf99507273+8c5ae1fdc5,gd7ef33dd92+0d594cb711,gdab6d2f7ff+3098891321,ge410e46f29+0d594cb711,geaed405ab2+c4bbc419c6,gf9a733ac38+8c5ae1fdc5,w.2025.38
LSST Data Management Base Package
Loading...
Searching...
No Matches
lsst.afw.display.interface Namespace Reference

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()

lsst.afw.display.interface._makeDisplayImpl ( display,
backend,
* args,
** kwargs )
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 1022 of file interface.py.

1022def delAllDisplays():
1023 """Delete and close all known displays.
1024 """
1025 return Display.delAllDisplays()

◆ getDefaultBackend()

lsst.afw.display.interface.getDefaultBackend ( )

Definition at line 957 of file interface.py.

957def getDefaultBackend():
958 return Display.getDefaultBackend()
959
960

◆ getDefaultFrame()

lsst.afw.display.interface.getDefaultFrame ( )
Get the default frame for display.

Definition at line 965 of file interface.py.

965def getDefaultFrame():
966 """Get the default frame for display.
967 """
968 return Display.getDefaultFrame()
969
970

◆ 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 996 of file interface.py.

996def getDisplay(frame=None, backend=None, create=True, verbose=False, **kwargs):
997 """Return a specific `Display`, creating it if need be.
998
999 Parameters
1000 ----------
1001 frame
1002 Desired frame (`None` => use defaultFrame (see `setDefaultFrame`)).
1003 backend : `str`
1004 Create the specified frame using this backend (or the default if
1005 `None`) if it doesn't already exist. If ``backend == ""``, it's an
1006 error to specify a non-existent ``frame``.
1007 create : `bool`
1008 Create the display if it doesn't already exist.
1009 verbose : `bool`
1010 Allow backend to be chatty.
1011 **kwargs
1012 Keyword arguments passed to `Display` constructor.
1013
1014 See also
1015 --------
1016 Display.getDisplay
1017 """
1018
1019 return Display.getDisplay(frame, backend, create, verbose, **kwargs)
1020
1021

◆ h_callback()

lsst.afw.display.interface.h_callback ( k,
x,
y )

Definition at line 945 of file interface.py.

945def h_callback(k, x, y):
946 print("Enter q or <ESC> to leave interactive mode, h for this help, or a letter to fire a callback")
947 return False
948
949# Handle Displays, including the default one (the frame to use when a user specifies None)
950# If the default frame is None, image display is disabled
951
952

◆ incrDefaultFrame()

lsst.afw.display.interface.incrDefaultFrame ( )
Increment the default frame for display.

Definition at line 971 of file interface.py.

971def incrDefaultFrame():
972 """Increment the default frame for display.
973 """
974 return Display.incrDefaultFrame()
975
976

◆ noop_callback()

lsst.afw.display.interface.noop_callback ( k,
x,
y )
Callback function

Parameters
----------
key
x
y

Definition at line 933 of file interface.py.

933def noop_callback(k, x, y):
934 """Callback function
935
936 Parameters
937 ----------
938 key
939 x
940 y
941 """
942 return False
943
944

◆ setDefaultBackend()

lsst.afw.display.interface.setDefaultBackend ( backend)

Definition at line 953 of file interface.py.

953def setDefaultBackend(backend):
954 Display.setDefaultBackend(backend)
955
956

◆ setDefaultFrame()

lsst.afw.display.interface.setDefaultFrame ( frame = 0)

Definition at line 961 of file interface.py.

961def setDefaultFrame(frame=0):
962 return Display.setDefaultFrame(frame)
963
964

◆ 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 981 of file interface.py.

981def setDefaultMaskPlaneColor(name=None, color=None):
982 """Set the default mapping from mask plane names to colors.
983
984 Parameters
985 ----------
986 name : `str` or `dict`
987 Name of mask plane, or a dict mapping names to colors.
988 If ``name`` is `None`, use the hard-coded default dictionary.
989 color : `str`
990 Desired color, or `None` if ``name`` is a dict.
991 """
992
993 return Display.setDefaultMaskPlaneColor(name, color)
994
995

◆ setDefaultMaskTransparency()

lsst.afw.display.interface.setDefaultMaskTransparency ( maskPlaneTransparency = {})

Definition at line 977 of file interface.py.

977def setDefaultMaskTransparency(maskPlaneTransparency={}):
978 return Display.setDefaultMaskTransparency(maskPlaneTransparency)
979
980

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.