Classes
class	Display

class	Event

Functions
	_makeDisplayImpl (display, backend, args, *kwargs)

	noop_callback (k, x, y)

	h_callback (k, x, y)

	setDefaultBackend (backend)

	getDefaultBackend ()

	setDefaultFrame (frame=0)

	getDefaultFrame ()

	incrDefaultFrame ()

	setDefaultMaskTransparency (maskPlaneTransparency={})

	setDefaultMaskPlaneColor (name=None, color=None)

	getDisplay (frame=None, backend=None, create=True, verbose=False, **kwargs)

	delAllDisplays ()

Variables
	logger = logging.getLogger(__name__)

str	WHITE = "white"

str	BLACK = "black"

str	RED = "red"

str	GREEN = "green"

str	BLUE = "blue"

str	CYAN = "cyan"

str	MAGENTA = "magenta"

str	YELLOW = "yellow"

str	ORANGE = "orange"

str	IGNORE = "ignore"

Function Documentation

◆ _makeDisplayImpl()

lsst.afw.display.interface._makeDisplayImpl	(		display,
			backend,
		*	args,
		**	kwargs )

protected

Return the ``DisplayImpl`` for the named backend

Parameters
----------
display : `str`
    Name of device. Should be importable, either absolutely or relative to lsst.display
backend : `str`
    The desired backend
*args
    Arguments passed to DisplayImpl.__init__
*kwargs
    Keywords arguments passed to DisplayImpl.__init__

Examples
--------
E.g.

.. code-block:: py

     import lsst.afw.display as afwDisplay
     display = afwDisplay.Display(backend="ds9")

 would call

.. code-block:: py

     _makeDisplayImpl(..., "ds9", 1)

and import the ds9 implementation of ``DisplayImpl`` from `lsst.display.ds9`

Definition at line 53 of file interface.py.

def _makeDisplayImpl(display, backend, *args, **kwargs):
    """Return the ``DisplayImpl`` for the named backend
 
    Parameters
    ----------
    display : `str`
        Name of device. Should be importable, either absolutely or relative to lsst.display
    backend : `str`
        The desired backend
    *args
        Arguments passed to DisplayImpl.__init__
    *kwargs
        Keywords arguments passed to DisplayImpl.__init__
 
    Examples
    --------
    E.g.
 
    .. code-block:: py
 
         import lsst.afw.display as afwDisplay
         display = afwDisplay.Display(backend="ds9")
 
     would call
 
    .. code-block:: py
 
         _makeDisplayImpl(..., "ds9", 1)
 
    and import the ds9 implementation of ``DisplayImpl`` from `lsst.display.ds9`
    """
    _disp = None
    exc = None
    candidateBackends = (f"lsst.display.{backend}", backend, f".{backend}", f"lsst.afw.display.{backend}")
    for dt in candidateBackends:
        exc = None
        # only specify the root package if we are not doing an absolute import
        impargs = {}
        if dt.startswith("."):
            impargs["package"] = "lsst.display"
        try:
            _disp = importlib.import_module(dt, **impargs)
            # If _disp doesn't have a DisplayImpl attribute, we probably
            # picked up an irrelevant module due to a name collision
            if hasattr(_disp, "DisplayImpl"):
                break
            else:
                _disp = None
        except (ImportError, SystemError) as e:
            # SystemError can be raised in Python 3.5 if a relative import
            # is attempted when the root package, lsst.display, does not exist.
            # Copy the exception into outer scope
            exc = e
 
    if not _disp or not hasattr(_disp.DisplayImpl, "_show"):
        # If available, re-use the final exception from above
        e = ImportError(f"Could not load the requested backend: {backend} "
                        f"(tried {', '.join(candidateBackends)}, but none worked).")
        if exc is not None:
            raise e from exc
        else:
            raise e
 
    if display:
        _impl = _disp.DisplayImpl(display, *args, **kwargs)
        if not hasattr(_impl, "frame"):
            _impl.frame = display.frame
 
        return _impl
    else:
        return True
 
 

◆ delAllDisplays()

lsst.afw.display.interface.delAllDisplays ( )

Delete and close all known displays.

Definition at line 1002 of file interface.py.

def delAllDisplays():
    """Delete and close all known displays.
    """
    return Display.delAllDisplays()

◆ getDefaultBackend()

lsst.afw.display.interface.getDefaultBackend ( )

Definition at line 937 of file interface.py.

def getDefaultBackend():
    return Display.getDefaultBackend()

◆ getDefaultFrame()

lsst.afw.display.interface.getDefaultFrame ( )

Get the default frame for display.

Definition at line 945 of file interface.py.

def getDefaultFrame():
    """Get the default frame for display.
    """
    return Display.getDefaultFrame()
 
 

◆ getDisplay()

lsst.afw.display.interface.getDisplay	(		frame = None,
			backend = None,
			create = True,
			verbose = False,
		**	kwargs )

Return a specific `Display`, creating it if need be.

Parameters
----------
frame
    Desired frame (`None` => use defaultFrame (see `setDefaultFrame`)).
backend : `str`
    Create the specified frame using this backend (or the default if
    `None`) if it doesn't already exist. If ``backend == ""``, it's an
    error to specify a non-existent ``frame``.
create : `bool`
    Create the display if it doesn't already exist.
verbose : `bool`
    Allow backend to be chatty.
**kwargs
    Keyword arguments passed to `Display` constructor.

See also
--------
Display.getDisplay

Definition at line 976 of file interface.py.

def getDisplay(frame=None, backend=None, create=True, verbose=False, **kwargs):
    """Return a specific `Display`, creating it if need be.
 
    Parameters
    ----------
    frame
        Desired frame (`None` => use defaultFrame (see `setDefaultFrame`)).
    backend : `str`
        Create the specified frame using this backend (or the default if
        `None`) if it doesn't already exist. If ``backend == ""``, it's an
        error to specify a non-existent ``frame``.
    create : `bool`
        Create the display if it doesn't already exist.
    verbose : `bool`
        Allow backend to be chatty.
    **kwargs
        Keyword arguments passed to `Display` constructor.
 
    See also
    --------
    Display.getDisplay
    """
 
    return Display.getDisplay(frame, backend, create, verbose, **kwargs)
 
 

◆ h_callback()

lsst.afw.display.interface.h_callback	(	k,
		x,
		y )

Definition at line 925 of file interface.py.

def h_callback(k, x, y):
    print("Enter q or <ESC> to leave interactive mode, h for this help, or a letter to fire a callback")
    return False
 
# Handle Displays, including the default one (the frame to use when a user specifies None)
# If the default frame is None, image display is disabled
 
 

◆ incrDefaultFrame()

lsst.afw.display.interface.incrDefaultFrame ( )

Increment the default frame for display.

Definition at line 951 of file interface.py.

def incrDefaultFrame():
    """Increment the default frame for display.
    """
    return Display.incrDefaultFrame()
 
 

◆ noop_callback()

lsst.afw.display.interface.noop_callback	(	k,
		x,
		y )

Callback function

Parameters
----------
key
x
y

Definition at line 913 of file interface.py.

def noop_callback(k, x, y):
    """Callback function
 
    Parameters
    ----------
    key
    x
    y
    """
    return False
 
 

◆ setDefaultBackend()

lsst.afw.display.interface.setDefaultBackend ( backend )

Definition at line 933 of file interface.py.

def setDefaultBackend(backend):
    Display.setDefaultBackend(backend)

◆ setDefaultFrame()

lsst.afw.display.interface.setDefaultFrame ( frame = 0 )

Definition at line 941 of file interface.py.

def setDefaultFrame(frame=0):
    return Display.setDefaultFrame(frame)

◆ setDefaultMaskPlaneColor()

lsst.afw.display.interface.setDefaultMaskPlaneColor	(		name = None,
			color = None )

Set the default mapping from mask plane names to colors.

Parameters
----------
name : `str` or `dict`
    Name of mask plane, or a dict mapping names to colors.
    If ``name`` is `None`, use the hard-coded default dictionary.
color : `str`
    Desired color, or `None` if ``name`` is a dict.

Definition at line 961 of file interface.py.

def setDefaultMaskPlaneColor(name=None, color=None):
    """Set the default mapping from mask plane names to colors.
 
    Parameters
    ----------
    name : `str` or `dict`
        Name of mask plane, or a dict mapping names to colors.
        If ``name`` is `None`, use the hard-coded default dictionary.
    color : `str`
        Desired color, or `None` if ``name`` is a dict.
    """
 
    return Display.setDefaultMaskPlaneColor(name, color)
 
 

◆ setDefaultMaskTransparency()

lsst.afw.display.interface.setDefaultMaskTransparency ( maskPlaneTransparency = {} )

Definition at line 957 of file interface.py.

def setDefaultMaskTransparency(maskPlaneTransparency={}):
    return Display.setDefaultMaskTransparency(maskPlaneTransparency)

Variable Documentation

◆ BLACK

str lsst.afw.display.interface.BLACK = "black"

Definition at line 42 of file interface.py.

◆ BLUE

str lsst.afw.display.interface.BLUE = "blue"

Definition at line 45 of file interface.py.

◆ CYAN

str lsst.afw.display.interface.CYAN = "cyan"

Definition at line 46 of file interface.py.

◆ GREEN

str lsst.afw.display.interface.GREEN = "green"

Definition at line 44 of file interface.py.

◆ IGNORE

str lsst.afw.display.interface.IGNORE = "ignore"

Definition at line 50 of file interface.py.

◆ logger

lsst.afw.display.interface.logger = logging.getLogger(__name__)

Definition at line 38 of file interface.py.

◆ MAGENTA

str lsst.afw.display.interface.MAGENTA = "magenta"

Definition at line 47 of file interface.py.

◆ ORANGE

str lsst.afw.display.interface.ORANGE = "orange"

Definition at line 49 of file interface.py.

◆ RED

str lsst.afw.display.interface.RED = "red"

Definition at line 43 of file interface.py.

◆ WHITE

str lsst.afw.display.interface.WHITE = "white"

Definition at line 41 of file interface.py.

◆ YELLOW

str lsst.afw.display.interface.YELLOW = "yellow"

Definition at line 48 of file interface.py.

Classes

Functions

Variables