lsst.afw.display.virtualDevice.DisplayImpl Class Reference

Public Member Functions
	__init__ (self, display, verbose=False)
	__del__ (self)

Public Attributes
	display = display
	verbose = verbose
	frame

Protected Member Functions
	_close (self)
	_buffer (self, enable=True)
	_dot (self, symb, c, r, size, ctype, *args, **kwargs)
	_drawLines (self, points, ctype)
	_erase (self)
	_flush (self)
	_setCallback (self, what, func)
	_getEvent (self)
	_getMaskTransparency (self)
	_mtv (self, image, wcs=None, mask=None, title="", metadata=None)
	_setImageColormap (self, cmap)
	_setMaskTransparency (self, transparency, maskplane)
	_scale (self, algorithm, min, max, *args, unit=None, **kwargs)
	_show (self)
	_pan (self, r, c)
	_zoom (self, zoomfac)

Detailed Description

Back-end for display objects.

Parameters
----------
display
    The display object that we're providing the implementation for
verbose : `bool`
    be chatty?

Definition at line 23 of file virtualDevice.py.

Constructor & Destructor Documentation

__init__()

lsst.afw.display.virtualDevice.DisplayImpl.__init__	(		self,
			display,
			verbose = False )

Definition at line 33 of file virtualDevice.py.

__del__()

lsst.afw.display.virtualDevice.DisplayImpl.__del__

(

self

)

Definition at line 37 of file virtualDevice.py.

Member Function Documentation

_buffer()

lsst.afw.display.virtualDevice.DisplayImpl._buffer ( self, enable = True )

protected

Enable or disable buffering of writes to the display

Parameters
----------
enable : `bool`
    `True` or `False`, as appropriate

Definition at line 46 of file virtualDevice.py.

_close()

lsst.afw.display.virtualDevice.DisplayImpl._close ( self )

protected

Close the display, cleaning up any allocated resources

Definition at line 40 of file virtualDevice.py.

_dot()

lsst.afw.display.virtualDevice.DisplayImpl._dot ( self, symb, c, r, size, ctype, * args, ** kwargs )

protected

Draw a symbol at (c, r)

Parameters
----------
symb
    The desired symbol. See `dot` for details
c : `float`
    (x) column position
r : `float`
    (y) row position
size : `int`
    Size of symbol, in pixels
ctype : `str`
    The desired color, either e.g. `lsst.afw.display.RED` or a color name known to X11
*args
    Extra arguments to backend
**kwargs
    Extra keyword arguments to backend

Definition at line 57 of file virtualDevice.py.

_drawLines()

lsst.afw.display.virtualDevice.DisplayImpl._drawLines ( self, points, ctype )

protected

Draw line defined by the list points

Parameters
----------
points : `list` of `tuple` of `float`
    A list of 0-indexed positions [(x, y), (x, y), ...]
ctype : `str`
    The desired color, either e.g. `lsst.afw.display.RED` or a color name known to X11

Definition at line 81 of file virtualDevice.py.

_erase()

lsst.afw.display.virtualDevice.DisplayImpl._erase ( self )

protected

Erase all glyphs drawn on display

Definition at line 95 of file virtualDevice.py.

_flush()

lsst.afw.display.virtualDevice.DisplayImpl._flush ( self )

protected

Flush any I/O buffers

Definition at line 101 of file virtualDevice.py.

_getEvent()

lsst.afw.display.virtualDevice.DisplayImpl._getEvent ( self )

protected

Return an event generated by a keypress or mouse click

Definition at line 111 of file virtualDevice.py.

_getMaskTransparency()

lsst.afw.display.virtualDevice.DisplayImpl._getMaskTransparency ( self )

protected

Return the mask transparency for a display

Definition at line 122 of file virtualDevice.py.

_mtv()

lsst.afw.display.virtualDevice.DisplayImpl._mtv ( self, image, wcs = None, mask = None, title = "", metadata = None )

protected

Display an image and maybe a mask overlay on a display

Parameters
----------
image : `lsst.afw.image.Image`
    `~lsst.afw.image.Image` to display
mask : `lsst.afw.image.Mask`
    `~lsst.afw.image.Mask` to display
wcs : `lsst.afw.geom.SkyWcs`
    A Wcs to associate with data
title : `str`
    Name to display with the data
metadata : `lsst.daf.base.PropertySet`
    Additional metadata.

Definition at line 128 of file virtualDevice.py.

_pan()

lsst.afw.display.virtualDevice.DisplayImpl._pan ( self, r, c )

protected

Pan to a row and column

Parameters
----------
c : `float`
    Desired column (x) position
r : `float`
    Desired row (y) position

Definition at line 203 of file virtualDevice.py.

_scale()

lsst.afw.display.virtualDevice.DisplayImpl._scale ( self, algorithm, min, max, * args, unit = None, ** kwargs )

protected

Set the scaling from DN to displayed pixels

Parameters
----------
algorithm
    Scaling algorithm (e.g. linear)
min
    The minimum value of the stretch (or "zscale" or "minmax")
max
    The maximum value of the stretch
unit
    Units for min and max (e.g. Percent, Absolute, Sigma)
*args
    Optional arguments to the backend
**kwargs
    Optional keyword arguments to the backend

Definition at line 175 of file virtualDevice.py.

_setCallback()

lsst.afw.display.virtualDevice.DisplayImpl._setCallback ( self, what, func )

protected

Definition at line 107 of file virtualDevice.py.

_setImageColormap()

lsst.afw.display.virtualDevice.DisplayImpl._setImageColormap ( self, cmap )

protected

Set the desired colormap

Parameters
----------
cmap : `str`
    the name of a colormap (e.g. "gray") or a backend-specific object

Definition at line 150 of file virtualDevice.py.

_setMaskTransparency()

lsst.afw.display.virtualDevice.DisplayImpl._setMaskTransparency ( self, transparency, maskplane )

protected

Set the transparency of a maskplane

Parameters
----------
transparency : `float`
    The desired transparency, in the range [0, 100]
maskplane
    The maskplane to set (None: all)

Definition at line 161 of file virtualDevice.py.

_show()

lsst.afw.display.virtualDevice.DisplayImpl._show ( self )

protected

Show the requested display

Definition at line 197 of file virtualDevice.py.

_zoom()

lsst.afw.display.virtualDevice.DisplayImpl._zoom ( self, zoomfac )

protected

Set the zoom

Parameters
----------
zoomfac : `float`
    Zoom factor to use

Definition at line 216 of file virtualDevice.py.

Member Data Documentation

display

lsst.afw.display.virtualDevice.DisplayImpl.display = display

Definition at line 34 of file virtualDevice.py.

frame

lsst.afw.display.virtualDevice.DisplayImpl.frame

Definition at line 44 of file virtualDevice.py.

verbose

lsst.afw.display.virtualDevice.DisplayImpl.verbose = verbose

Definition at line 35 of file virtualDevice.py.

---

The documentation for this class was generated from the following file:

• python/lsst/afw/display/virtualDevice.py