Classes | |
| class | Info |
Functions | |
| getDebugFrame (debugDisplay, name) | |
Variables | |
| getInfo = Info | |
Function Documentation
◆ getDebugFrame()
| lsstDebug.getDebugFrame | ( | debugDisplay, | |
| name ) |
Attempt to extract a frame for displaying a product called ``name``
from the ``debugDisplay`` variable.
Per the above, an instance of `Info` can return an arbitrary object
(or nothing) as its ``display`` attribute. It is convenient -- though not
required -- that it be a dictionary mapping data products to frame
numbers, as shown in the `lsstDebug.Info` example. Given such a dictionary,
this function extracts and returns the appropriate frame number. If
``debugDisplay`` is not a collection, or if ``name`` is not found within
it, we return `None`.
Parameters
----------
debugDisplay : `object`
The contents of ``lsstDebug.Info(__name__).display``.
name : `str`
The name of the data product to be displayed.
Returns
-------
frame : `int`
A frame number, or `None`.
Definition at line 95 of file lsstDebug.py.
95def getDebugFrame(debugDisplay, name):
96 """
97 Attempt to extract a frame for displaying a product called ``name``
98 from the ``debugDisplay`` variable.
99
100 Per the above, an instance of `Info` can return an arbitrary object
101 (or nothing) as its ``display`` attribute. It is convenient -- though not
102 required -- that it be a dictionary mapping data products to frame
103 numbers, as shown in the `lsstDebug.Info` example. Given such a dictionary,
104 this function extracts and returns the appropriate frame number. If
105 ``debugDisplay`` is not a collection, or if ``name`` is not found within
106 it, we return `None`.
107
108 Parameters
109 ----------
110 debugDisplay : `object`
111 The contents of ``lsstDebug.Info(__name__).display``.
112 name : `str`
113 The name of the data product to be displayed.
114
115 Returns
116 -------
117 frame : `int`
118 A frame number, or `None`.
119 """
120 if hasattr(debugDisplay, "__contains__") and name in debugDisplay:
121 return debugDisplay[name]
122 else:
123 return None
Variable Documentation
◆ getInfo
| lsstDebug.getInfo = Info |
Definition at line 92 of file lsstDebug.py.
Generated on Sun Apr 6 2025 08:45:30 for LSST Applications by
1.13.2