lsst.afw  21.0.0-13-g512c41855+47cba9fc36
Classes | Functions | Variables
lsst.afw.display.interface Namespace Reference

Classes

class  Display
 
class  Event
 

Functions

def noop_callback (k, x, y)
 
def h_callback (k, x, y)
 
def setDefaultBackend (backend)
 
def getDefaultBackend ()
 
def setDefaultFrame (frame=0)
 
def getDefaultFrame ()
 
def incrDefaultFrame ()
 
def setDefaultMaskTransparency (maskPlaneTransparency={})
 
def setDefaultMaskPlaneColor (name=None, color=None)
 
def getDisplay (frame=None, backend=None, create=True, verbose=False, *args, **kwargs)
 
def delAllDisplays ()
 

Variables

 logger = lsst.log.Log.getLogger("afw.display.interface")
 
string WHITE = "white"
 
string BLACK = "black"
 
string RED = "red"
 
string GREEN = "green"
 
string BLUE = "blue"
 
string CYAN = "cyan"
 
string MAGENTA = "magenta"
 
string YELLOW = "yellow"
 
string ORANGE = "orange"
 
string IGNORE = "ignore"
 

Function Documentation

◆ delAllDisplays()

def lsst.afw.display.interface.delAllDisplays ( )
Delete and close all known displays

Definition at line 941 of file interface.py.

◆ getDefaultBackend()

def lsst.afw.display.interface.getDefaultBackend ( )

Definition at line 874 of file interface.py.

◆ getDefaultFrame()

def lsst.afw.display.interface.getDefaultFrame ( )
Get the default frame for display

Definition at line 882 of file interface.py.

◆ getDisplay()

def lsst.afw.display.interface.getDisplay (   frame = None,
  backend = None,
  create = True,
  verbose = False,
args,
**  kwargs 
)
Return a specific `Display`, creating it if need be

Parameters
----------
frame
    The 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
*args
    arguments passed to `Display` constructor
**kwargs
    keyword arguments passed to `Display` constructor

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

Definition at line 913 of file interface.py.

◆ h_callback()

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

Definition at line 859 of file interface.py.

◆ incrDefaultFrame()

def lsst.afw.display.interface.incrDefaultFrame ( )
Increment the default frame for display

Definition at line 888 of file interface.py.

◆ noop_callback()

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

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

Definition at line 847 of file interface.py.

◆ setDefaultBackend()

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

Definition at line 870 of file interface.py.

◆ setDefaultFrame()

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

Definition at line 878 of file interface.py.

◆ setDefaultMaskPlaneColor()

def 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 898 of file interface.py.

◆ setDefaultMaskTransparency()

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

Definition at line 894 of file interface.py.

Variable Documentation

◆ BLACK

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

Definition at line 45 of file interface.py.

◆ BLUE

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

Definition at line 48 of file interface.py.

◆ CYAN

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

Definition at line 49 of file interface.py.

◆ GREEN

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

Definition at line 47 of file interface.py.

◆ IGNORE

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

Definition at line 53 of file interface.py.

◆ logger

lsst.afw.display.interface.logger = lsst.log.Log.getLogger("afw.display.interface")

Definition at line 39 of file interface.py.

◆ MAGENTA

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

Definition at line 50 of file interface.py.

◆ ORANGE

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

Definition at line 52 of file interface.py.

◆ RED

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

Definition at line 46 of file interface.py.

◆ WHITE

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

Definition at line 44 of file interface.py.

◆ YELLOW

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

Definition at line 51 of file interface.py.