lsst.afw.display.utils Namespace Reference

Classes
class	Mosaic

Functions
def	_getDisplayFromDisplayOrFrame
	Return an afwDisplay.Display given either a display or a frame ID. More...
def	drawBBox
def	drawFootprint
def	drawCoaddInputs

Variables
tuple	__all__

Function Documentation

def lsst.afw.display.utils._getDisplayFromDisplayOrFrame (   display,   frame = None  )

private

Return an afwDisplay.Display given either a display or a frame ID.

If the two arguments are consistent, return the desired display; if they are not, raise a RuntimeError exception.

If the desired display is None, return None; if (display, frame) == ("deferToFrame", None), return the default display

Definition at line 36 of file utils.py.

def _getDisplayFromDisplayOrFrame(display, frame=None):
    """!Return an afwDisplay.Display given either a display or a frame ID.

    If the two arguments are consistent, return the desired display; if they are not,
    raise a RuntimeError exception.

    If the desired display is None, return None;
    if (display, frame) == ("deferToFrame", None), return the default display"""

    import lsst.afw.display as afwDisplay # import locally to allow this file to be imported by __init__

    if display in ("deferToFrame", None):
        if display is None and frame is None:
            return None

        # "deferToFrame" is the default value, and  means "obey frame"
        display = None

    if display and not hasattr(display, "frame"):
        raise RuntimeError("display == %s doesn't support .frame" % display)

    if frame and display and display.frame != frame:
        raise RuntimeError("Please specify display *or* frame")

    if display:
        frame = display.frame

    display = afwDisplay.getDisplay(frame, create=True)

    return display

#-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-