LSSTApplications  18.1.0
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
119 
def getDebugFrame(debugDisplay, name)
Definition: lsstDebug.py:90

Variable Documentation

◆ getInfo

lsstDebug.getInfo = Info

Definition at line 87 of file lsstDebug.py.