LSSTApplications  17.0+124,17.0+14,17.0+73,18.0.0+37,18.0.0+80,18.0.0-4-g68ffd23+4,18.1.0-1-g0001055+12,18.1.0-1-g03d53ef+5,18.1.0-1-g1349e88+55,18.1.0-1-g2505f39+44,18.1.0-1-g5315e5e+4,18.1.0-1-g5e4b7ea+14,18.1.0-1-g7e8fceb+4,18.1.0-1-g85f8cd4+48,18.1.0-1-g8ff0b9f+4,18.1.0-1-ga2c679d+1,18.1.0-1-gd55f500+35,18.1.0-10-gb58edde+2,18.1.0-11-g0997b02+4,18.1.0-13-gfe4edf0b+12,18.1.0-14-g259bd21+21,18.1.0-19-gdb69f3f+2,18.1.0-2-g5f9922c+24,18.1.0-2-gd3b74e5+11,18.1.0-2-gfbf3545+32,18.1.0-26-g728bddb4+5,18.1.0-27-g6ff7ca9+2,18.1.0-3-g52aa583+25,18.1.0-3-g8ea57af+9,18.1.0-3-gb69f684+42,18.1.0-3-gfcaddf3+6,18.1.0-32-gd8786685a,18.1.0-4-gf3f9b77+6,18.1.0-5-g1dd662b+2,18.1.0-5-g6dbcb01+41,18.1.0-6-gae77429+3,18.1.0-7-g9d75d83+9,18.1.0-7-gae09a6d+30,18.1.0-9-gc381ef5+4,w.2019.45
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 
lsstDebug.getDebugFrame
def getDebugFrame(debugDisplay, name)
Definition: lsstDebug.py:90

Variable Documentation

◆ getInfo

lsstDebug.getInfo = Info

Definition at line 87 of file lsstDebug.py.

Generated on Sat Nov 16 2019 09:15:53 for LSSTApplications by   doxygen 1.8.13