virtualDevice.py

Go to the documentation of this file.

from __future__ import print_function
from __future__ import absolute_import
from builtins import object
#
# LSST Data Management System
# Copyright 2008, 2009, 2010, 2015 LSST Corporation.
#
# This product includes software developed by the
# LSST Project (http://www.lsst.org/).
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the LSST License Statement and
# the GNU General Public License along with this program.  If not,
# see <http://www.lsstcorp.org/LegalNotices/>.
#

##
## \file
## \brief A dummy image display

class DisplayImpl(object):
    def __init__(self, display, verbose=False):
        """! Initialise the display
        \param display The display object that we're providing the implementation for
        \param verbose be chatty?
        """
        self.display = display
        self.verbose = verbose

    def __del__(self):
        self._close()

    def _close(self):
        """!Close the display, cleaning up any allocated resources"""
        if hasattr(self, "verbose") and self.verbose and hasattr(self, "display"):
            print("virtual[%s]._close()" % (self.frame))

    def _buffer(self, enable=True):
        """!Enable or disable buffering of writes to the display
        \param enable  True or False, as appropriate
        """
        if self.verbose:
            print("virtual[%s]._buffer(%s)" % (self.frame, enable))

    def _dot(self, symb, c, r, size, ctype, *args, **kwargs):
        """!Draw symbol a symbol at (c, r)
        \param symb The desired symbol.  See dot() for details
        \param c (x) column position
        \param r (y) row position
        \param size  Size of symbol, in pixels
        \param ctype The desired colour, either e.g. afw.display.RED or a colour name known to X11
        \param args  Extra arguments
        \param kwargs Extra keyword arguments
        """
        if self.verbose:
            print("virtual[%s]._dot('%s', %.2f, %.2f, size=%g, ctype=%s, %s, %s)" % \
                (self.frame, symb, c, r, size, ctype, args, kwargs))

    def _drawLines(self, points, ctype):
        """!Draw line defined by the list points
        \param points A list of 0-indexed positions [(x, y), (x, y), ...]
        \param ctype The desired colour, either e.g. afw.display.RED or a colour name known to X11
        """
        if self.verbose:
            print("virtual[%s]._drawLines(%s, ctype=%s)" % (self.frame, points, ctype))

    def _erase(self):
        """!Erase all glyphs drawn on display
        """
        if self.verbose:
            print("virtual[%s]._erase()" % (self.frame))

    def _flush(self):
        """!Flush any I/O buffers
        """
        if self.verbose:
            print("virtual[%s]._flush()" % self.frame)

    def _setCallback(self, what, func):
        if self.verbose > 1:
            print("setCallback %s -> %s" % (what, func))

    def _getEvent(self):
        """Return an event generated by a keypress or mouse click
        """
        from .interface import Event
        ev = Event("q")

        if self.verbose:
            print("virtual[%s]._getEvent() -> %s" % (self.frame, ev))

        return ev

    def _getMaskTransparency(self):
        """Return the mask transparency for a display
        """
        if self.verbose:
            print("virtual[%s]._getMaskTransparency()" % self.frame)

    def _mtv(self, image, wcs=None, mask=None, title=""):
        """Display an image and maybe a mask overlay on a display
        \param image afwImage.Image to display
        \param mask afwImage.Mask to display
        \param wcs A Wcs to associate with data
        \param title Name to display with the data
        """
        if self.verbose:
            print("virtual[%s]._mtv(image=%s, mask=%s, wcs=%s, title=\"%s\")" % \
                (self.frame, "Image" if image else None,
                 "Mask" if mask else None, "Wcs" if wcs else None, title))

    def _setMaskTransparency(self, transparency, maskplane):
        """Set the transparency of a maskplane
        \param transparency The desired transparency, in the range [0, 100]
        \param maskplane The maskplane to set (None: all)
        """
        if self.verbose:
            print("virtual[%s]._setMaskTransparency(%g, maskplane=\"%s\")" % (self.frame, transparency, maskplane))

    def _scale(self, algorithm, min, max, unit=None, *args, **kwargs):
        """Set the scaling from DN to displayed pixels
        \param algorithm Scaling algorithm (e.g. linear)
        \param min  The minimum value of the stretch (or "zscale" or "minmax")
        \param max  The maximum value of the stretch
        \param unit Units for min and max (e.g. Percent, Absolute, Sigma)
        \param *args Optional arguments
        \param **kwargs Optional keyword arguments
        """
        if self.verbose:
            print("virtual[%s]._scale(%s, %s, %s, %s, %s, %s)" % (self.frame, algorithm,
                                                                 min, max, unit, args, kwargs))

    def _show(self):
        """Show the requested display
        """
        if self.verbose:
            print("virtual[%s]._show()" % self.frame)

    def _pan(self, r, c):
        """Pan to (colc, rowc)
        \param c Desired column (x) position
        \param r Desired row (y) position
        """
        if self.verbose:
            print("virtual[%s]._pan(%.2f, %.2f)" % (self.frame, r, c))

    def _zoom(self, zoomfac):
        """Set the zoom
        \param zoomfac  Zoom factor to use
        """
        if self.verbose:
            print("virtual[%s]._zoom(%g)" % (self.frame, zoomfac))