LSST Applications  21.0.0-172-gfb10e10a+18fedfabac,22.0.0+297cba6710,22.0.0+80564b0ff1,22.0.0+8d77f4f51a,22.0.0+a28f4c53b1,22.0.0+dcf3732eb2,22.0.1-1-g7d6de66+2a20fdde0d,22.0.1-1-g8e32f31+297cba6710,22.0.1-1-geca5380+7fa3b7d9b6,22.0.1-12-g44dc1dc+2a20fdde0d,22.0.1-15-g6a90155+515f58c32b,22.0.1-16-g9282f48+790f5f2caa,22.0.1-2-g92698f7+dcf3732eb2,22.0.1-2-ga9b0f51+7fa3b7d9b6,22.0.1-2-gd1925c9+bf4f0e694f,22.0.1-24-g1ad7a390+a9625a72a8,22.0.1-25-g5bf6245+3ad8ecd50b,22.0.1-25-gb120d7b+8b5510f75f,22.0.1-27-g97737f7+2a20fdde0d,22.0.1-32-gf62ce7b1+aa4237961e,22.0.1-4-g0b3f228+2a20fdde0d,22.0.1-4-g243d05b+871c1b8305,22.0.1-4-g3a563be+32dcf1063f,22.0.1-4-g44f2e3d+9e4ab0f4fa,22.0.1-42-gca6935d93+ba5e5ca3eb,22.0.1-5-g15c806e+85460ae5f3,22.0.1-5-g58711c4+611d128589,22.0.1-5-g75bb458+99c117b92f,22.0.1-6-g1c63a23+7fa3b7d9b6,22.0.1-6-g50866e6+84ff5a128b,22.0.1-6-g8d3140d+720564cf76,22.0.1-6-gd805d02+cc5644f571,22.0.1-8-ge5750ce+85460ae5f3,master-g6e05de7fdc+babf819c66,master-g99da0e417a+8d77f4f51a,w.2021.48
LSST Data Management Base Package
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(__name__)
 
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.

941 def delAllDisplays():
942  """Delete and close all known displays
943  """
944  return Display.delAllDisplays()

◆ getDefaultBackend()

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

Definition at line 874 of file interface.py.

874 def getDefaultBackend():
875  return Display.getDefaultBackend()
876 
877 

◆ getDefaultFrame()

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

Definition at line 882 of file interface.py.

882 def getDefaultFrame():
883  """Get the default frame for display
884  """
885  return Display.getDefaultFrame()
886 
887 

◆ 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.

913 def getDisplay(frame=None, backend=None, create=True, verbose=False, *args, **kwargs):
914  """Return a specific `Display`, creating it if need be
915 
916  Parameters
917  ----------
918  frame
919  The desired frame (`None` => use defaultFrame (see `setDefaultFrame`))
920  backend : `str`
921  Create the specified frame using this backend (or the default if
922  `None`) if it doesn't already exist. If ``backend == ""``, it's an
923  error to specify a non-existent ``frame``.
924  create : `bool`
925  Create the display if it doesn't already exist.
926  verbose : `bool`
927  Allow backend to be chatty
928  *args
929  arguments passed to `Display` constructor
930  **kwargs
931  keyword arguments passed to `Display` constructor
932 
933  See also
934  --------
935  Display.getDisplay
936  """
937 
938  return Display.getDisplay(frame, backend, create, verbose, *args, **kwargs)
939 
940 
lsst::afw.display.interface.getDisplay
def getDisplay(frame=None, backend=None, create=True, verbose=False, *args, **kwargs)
Definition: interface.py:913

◆ h_callback()

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

Definition at line 859 of file interface.py.

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

◆ incrDefaultFrame()

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

Definition at line 888 of file interface.py.

888 def incrDefaultFrame():
889  """Increment the default frame for display
890  """
891  return Display.incrDefaultFrame()
892 
893 

◆ 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.

847 def noop_callback(k, x, y):
848  """Callback function
849 
850  Parameters
851  ----------
852  key
853  x
854  y
855  """
856  return False
857 
858 
lsst::afw.display.interface.noop_callback
def noop_callback(k, x, y)
Definition: interface.py:847

◆ setDefaultBackend()

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

Definition at line 870 of file interface.py.

870 def setDefaultBackend(backend):
871  Display.setDefaultBackend(backend)
872 
873 
lsst::afw.display.interface.setDefaultBackend
def setDefaultBackend(backend)
Definition: interface.py:870

◆ setDefaultFrame()

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

Definition at line 878 of file interface.py.

878 def setDefaultFrame(frame=0):
879  return Display.setDefaultFrame(frame)
880 
881 
lsst::afw.display.interface.setDefaultFrame
def setDefaultFrame(frame=0)
Definition: interface.py:878

◆ 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.

898 def setDefaultMaskPlaneColor(name=None, color=None):
899  """Set the default mapping from mask plane names to colors
900 
901  Parameters
902  ----------
903  name : `str` or `dict`
904  name of mask plane, or a dict mapping names to colors.
905  If ``name`` is `None`, use the hard-coded default dictionary
906  color : `str`
907  Desired color, or `None` if ``name`` is a dict
908  """
909 
910  return Display.setDefaultMaskPlaneColor(name, color)
911 
912 
lsst::afw.display.interface.setDefaultMaskPlaneColor
def setDefaultMaskPlaneColor(name=None, color=None)
Definition: interface.py:898

◆ setDefaultMaskTransparency()

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

Definition at line 894 of file interface.py.

894 def setDefaultMaskTransparency(maskPlaneTransparency={}):
895  return Display.setDefaultMaskTransparency(maskPlaneTransparency)
896 
897 
lsst::afw.display.interface.setDefaultMaskTransparency
def setDefaultMaskTransparency(maskPlaneTransparency={})
Definition: interface.py:894

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(__name__)

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.

Generated on Fri Nov 26 2021 10:16:10 for LSST Applications by doxygen 1.9.1