LSSTApplications  19.0.0-10-g920eed2,19.0.0-11-g48a0200+2,19.0.0-18-gfc4e62b+13,19.0.0-2-g3b2f90d+2,19.0.0-2-gd671419+5,19.0.0-20-g5a5a17ab+11,19.0.0-21-g2644856+13,19.0.0-23-g84eeccb+1,19.0.0-24-g878c510+1,19.0.0-25-g6c8df7140,19.0.0-25-gb330496+1,19.0.0-3-g2b32d65+5,19.0.0-3-g8227491+12,19.0.0-3-g9c54d0d+12,19.0.0-3-gca68e65+8,19.0.0-3-gcfc5f51+5,19.0.0-3-ge110943+11,19.0.0-3-ge74d124,19.0.0-3-gfe04aa6+13,19.0.0-30-g9c3fd16+1,19.0.0-4-g06f5963+5,19.0.0-4-g3d16501+13,19.0.0-4-g4a9c019+5,19.0.0-4-g5a8b323,19.0.0-4-g66397f0+1,19.0.0-4-g8278b9b+1,19.0.0-4-g8557e14,19.0.0-4-g8964aba+13,19.0.0-4-ge404a01+12,19.0.0-5-g40f3a5a,19.0.0-5-g4db63b3,19.0.0-5-gfb03ce7+13,19.0.0-6-gbaebbfb+12,19.0.0-61-gec4c6e08+1,19.0.0-7-g039c0b5+11,19.0.0-7-gbea9075+4,19.0.0-7-gc567de5+13,19.0.0-71-g41c0270,19.0.0-9-g2f02add+1,19.0.0-9-g463f923+12,w.2020.22
LSSTDataManagementBasePackage
Classes | Functions | Variables
lsstDebug Namespace Reference

Classes

class  Info
 

Functions

def getDebugFrame (debugDisplay, name)
 

Variables

 getInfo = Info
 

Function Documentation

◆ getDebugFrame()

def 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 90 of file lsstDebug.py.

90 def getDebugFrame(debugDisplay, name):
91  """
92  Attempt to extract a frame for displaying a product called ``name``
93  from the ```debugDisplay`` variable.
94 
95  Per the above, an instance of `Info` can return an arbitrary object
96  (or nothing) as its ``display`` attribute. It is convenient -- though not
97  required -- that it be a dictionary mapping data products to frame
98  numbers, as shown in the `lsstDebug.Info` example. Given such a dictionary,
99  this function extracts and returns the appropriate frame number. If
100  ``debugDisplay`` is not a collection, or if ``name`` is not found within
101  it, we return `None`.
102 
103  Parameters
104  ----------
105  debugDisplay : `object`
106  The contents of lsstDebug.Info(__name__).display.
107  name : `str`
108  The name of the data product to be displayed.
109 
110  Returns
111  -------
112  frame : `int`
113  A frame number, or `None`.
114  """
115  if hasattr(debugDisplay, "__contains__") and name in debugDisplay:
116  return debugDisplay[name]
117  else:
118  return None

Variable Documentation

◆ getInfo

lsstDebug.getInfo = Info

Definition at line 87 of file lsstDebug.py.

lsstDebug.getDebugFrame
def getDebugFrame(debugDisplay, name)
Definition: lsstDebug.py:90