python3-csb 1.2.2+dfsg-2ubuntu1 / usr / lib / python3 / dist-packages / csb / io / plots.py

"""
Plotting facilities, based on Python's MPL library.

The L{Chart} object is a facade which provides intuitive access to MPL's plotting
objects. The following examples show a typical use of L{Chart}:

    1. Instantiation
    
    >>> chart = Chart()                     # a chart with a single plot    
    >>> chart = Chart(rows=2, columns=2)    # a chart with 2x2=4 plots
    
    2. Accessing plots (equivalent to MPL's subplots)

    >>> chart.plots[0]                      # first plot (at row=0, column=0) 
    Plot (matplotlib.axes.AxesSubplot)    
    >>> chart.plots[0, 1]
    Plot (matplotlib.axes.AxesSubplot)      # plot at row=0, column=1
    
    3. Plotting
    
    >>> chart.plots[0].hist(...)
    >>> chart.plots[0].set_title('T')
        
    >>> chart.plots[1].scatter(...)
    >>> chart.plots[1].set_xlabel('X')
    
    4. Using the GUI
    
    >>> chart.show()
    >>> chart.hide()
    
    5. Saving as image
    
    >>> chart.save(filename, format=chart.formats.PDF)
    
If using the GUI, do not forget to dispose the chart at the end:

    >>> chart.dispose()
    
or simply use the chart in a context manager:

    >>> with Chart() as chart:
            chart...
"""

import time
import csb.core

from abc import ABCMeta, abstractmethod

from threading import Thread, Event

from matplotlib.figure import Figure
from matplotlib.backends.backend_agg import FigureCanvasAgg


class Backend(Thread):
    """
    Abstract class defining the behavior of all Chart GUI backends.
    
    Each backend is a 'daemon' that runs in a new thread and handles
    all GUI requests from any L{Chart} instance. A backend service must
    behave as a singleton - only one service of a given kind may exist at a
    given point in time. L{Chart} clients will request GUI operations
    on specific figures, the Backend therefore must keep track of all
    windows opened, as well as the figure-to-window mapping.
    """
    
    __metaclass__ = ABCMeta
    _instances = {}
    
    @staticmethod
    def get(backend, started=True):
        """
        Backend factory, ensures one instance per subclass. 
        
        @param backend: one of the L{Backend} subclasses
        @type backend: type
        @param started: if True, ensure that the service is running
        @type started: bool
        
        @return: an instance of the backend. The returned service
                 instance may need to be started.
        @rtype: L{Backend}
        """

        if not issubclass(backend, Backend):
            raise TypeError(backend)
        
        if backend in Backend._instances:
            instance = Backend._instances[backend]
        else:
            instance = backend()

        if started and not instance.started:
            instance.start()  
        return instance

    @staticmethod
    def query(backend):
        """        
        @param backend: one of the L{Backend} subclasses
        @type backend: type
        
        @return: True if a service of type C{backend} is running
        @rtype: bool
        """

        if not issubclass(backend, Backend):
            raise TypeError(backend)
        
        if backend in Backend._instances:
            instance = Backend._instances[backend]
            return instance.started

        else:
            return False
        
    def __init__(self):
        
        name = self.__class__
        if name in Backend._instances:
            raise RuntimeError('Backend {0} has already been initialized'.format(name))
        else:
            Backend._instances[name] = self         
        
        super(Backend, self).__init__()
        
        self._figures = {}
        self._started = Event()        
        self._running = Event()
                
        self.setDaemon(True)
        
    @property
    def started(self):
        """
        True if the service had been started
        @rtype: bool
        """
        return self._started.isSet()
    
    @property
    def running(self):
        """
        True if the service had been started and is currently running
        @rtype: bool
        """        
        return self._running.isSet()    
                
    @abstractmethod
    def _initapp(self):
        """
        Create an instance of the GUI application.
        """
        pass
    
    @abstractmethod
    def _mainloop(self):
        """
        Enter the GUI main loop.
        """
        pass
    
    @abstractmethod
    def _exit(self):
        """
        Delete all frames, exit the GUI main loop and perform any cleanup
        needed in order to unblock the thread that started the main loop.
        """
        pass    
    
    @abstractmethod
    def _add(self, figure):
        """
        Handle an 'Add new figure' event
        """
        pass
    
    @abstractmethod    
    def _show(self, figure):
        """
        Handle a 'Show existing figure' event
        """
        pass

    @abstractmethod    
    def _resize(self, figure):
        """
        Handle a 'Resize existing figure' event
        """
        pass
    
    @abstractmethod    
    def _hide(self, figure):
        """
        Handle a 'Hide existing figure' event
        """
        pass

    @abstractmethod        
    def _destroy(self, figure):
        """
        Handle a 'Delete existing figure' event
        """        
        pass

    @abstractmethod
    def _invoke(self, callable, *args):
        """
        Pass a GUI message: invoke C{callable} in a thread-safe way
        """
        pass
    
    def invoke(self, callable, *args):
        """
        Invoke an asynchronous GUI operation (in a thread-safe way) 
        """
        if not self._running.isSet():
            raise RuntimeError('The backend service is not running')
        else:
            self._invoke(callable, *args)
                
    def add(self, figure):
        """
        Add a new figure.
        """
        self.invoke(self._add, figure)

    def show(self, figure):
        """
        Show existing figure.
        """        
        self.invoke(self._show, figure)

    def resize(self, figure):
        """
        Resize existing figure.
        """        
        self.invoke(self._resize, figure)
            
    def hide(self, figure):
        """
        Hide existing figure.
        """        
        self.invoke(self._hide, figure)
        
    def destroy(self, figure, wait=False):
        """
        Destroy existing figure. If C{wait} is True, make sure the asynchronous
        figure deletion is complete before returning from the method.
        """        
        has_figure = (figure in self._figures)
        self.invoke(self._destroy, figure)
        
        if has_figure and wait:
            while figure in self._figures:
                pass       
                
    def start(self):
        """
        Start the Backend service. This method can be called only once.
        """
        try:
            super(Backend, self).start()
        
            while not self._running.isSet():
                time.sleep(0.05)
                
        except BaseException:
            raise RuntimeError("Failed to start the backend service")
    
    def run(self):
        """
        Main service method, automatically called by C{start}.
        """
        self._started.set()
        
        self._initapp()
        self._running.set()
        
        self._mainloop()

        self._running.clear()
        self._started.clear()
        
    def stop(self):
        """
        Stop the Backend service. The Backend object can be safely
        disposed afterwards.
        """
        self._exit()
        self._figures = {}
        self.join()
        self._running.clear()
        self._started.clear()
        del Backend._instances[self.__class__]
    
    def client_disposed(self, client):
        """
        Fired when a client is being deleted. Will stop the service if no
        active clients are remaining.
        """
        if self._figures is None or len(self._figures) == 0:
            self.stop()
            
    def __del__(self):
        if self._started.isSet():
            self.stop()
    
class WxBackendImpl(Backend):
    """
    WxPython L{Backend} implementor.
    
    @note: not meant to be instantiated directly, use L{Backend.get} instead.
    """
    
    _wxapp = None
    
    def __init__(self):
        
        import wx
        from matplotlib.backends.backend_wx import FigureFrameWx
        
        self._wx = wx
        self._FigureFrameWx = FigureFrameWx
        
        super(WxBackendImpl, self).__init__()
    
    @property
    def _app(self):
        if WxBackendImpl._wxapp is None:
            WxBackendImpl._wxapp = self._wx.PySimpleApp()
        return WxBackendImpl._wxapp
                    
    def _initapp(self):
      
        dummy = self._app
        frame = self._wx.Frame(None)
        frame.Show()
        frame.Hide()
        
    def _mainloop(self):
        
        self._app.MainLoop()
        
    def _add(self, figure):
                
        wx = self._wx
        FigureFrameWx = self._FigureFrameWx
        
        if figure not in self._figures:
            
            frame = FigureFrameWx(figure._figure_number, figure)
            frame.Show()
            frame.Bind(wx.EVT_ACTIVATE, lambda e: e.GetEventObject().Layout())
            frame.Bind(wx.EVT_CLOSE, lambda e: self.invoke(self._hide, figure))

            self._figures[figure] = frame

    def _show(self, figure):
        
        if figure not in self._figures:
            self._add(figure)
        
        self._figures[figure].Show()
        
    def _resize(self, figure):
        
        if figure in self._figures:
            
            frame = self._figures[figure]
            
            w = figure.get_figwidth() * figure.get_dpi()
            h = figure.get_figheight() * figure.get_dpi()
            
            size = self._wx.Size(w, h)
            frame.canvas.SetInitialSize(size)
            frame.GetSizer().Fit(frame)
        
    def _hide(self, figure):
        
        if figure in self._figures:
            self._figures[figure].Hide()                

    def _destroy(self, figure):
        
        if figure in self._figures:
            frame = self._figures[figure]
            if not frame.IsBeingDeleted():
                frame.Destroy()            
            del self._figures[figure]
                
    def _invoke(self, callable, *args):
        
        wx = self._wx
        wx.CallAfter(callable, *args)
                    
    def _exit(self):
        
        for frame in self._figures.values():
            if not frame.IsBeingDeleted():
                frame.Destroy()
        self._app.Exit()
        
class Backends(object):
    """
    Enumeration of chart backends.
    """
    
    WX_WIDGETS = WxBackendImpl
        

class PlotsCollection(object):
    """
    A list-like collection of all plots in the chart (0-based).
    """
    
    def __init__(self, figure, rows=1, columns=1):
        
        assert rows >= 1 and columns >= 1
                
        self._plots = []
        self._figure = figure
        self._rows = int(rows)
        self._columns = int(columns)
    
        for dummy in range(self._rows * self._columns):
            self._plots.append(None)
            
    @property
    def _active_plots(self):
        return [p for p in self._plots if p is not None]
            
    def _add(self, index=1):
        
        assert 0 <= index < len(self._plots)
          
        plot = self._figure.add_subplot(self._rows, self._columns, index + 1)
        self._plots[index] = plot
        
        return plot
    
    def __getitem__(self, location):
        
        if isinstance(location, tuple):
            row, col = location 
            i = row * self._columns + col
        else:
            i = int(location)
            
        if not (0 <= i < len(self._plots)):
            raise IndexError("No such plot: {0}".format(location))
        
        if self._plots[i] is None:
            return self._add(i)
        else:
            return self._plots[i]
        
    def __len__(self):
        return len(self._active_plots)
    
    def __iter__(self):
        return iter(self._active_plots)
    
              
class Chart(object):
    """
    Simple and clean facade to Matplotlib's plotting API.
    
    A chart instance abstracts a plotting device, on which one or
    multiple related plots can be drawn. Charts can be exported as images, or
    visualized interactively. Each chart instance will always open in its own
    GUI window, and this window will never block the execution of the rest of
    the program, or interfere with other L{Chart}s.
    The GUI can be safely opened in the background and closed infinite number
    of times, as long as the client program is still running.
    
    By default, a chart contains a single plot:
    
    >>> chart.plot
    matplotlib.axes.AxesSubplot
    >>> chart.plot.hist(...)
    
    If C{rows} and C{columns} are defined, the chart will contain
    C{rows} x C{columns} number of plots (equivalent to MPL's sub-plots).
    Each plot can be assessed by its index:
    
    >>> chart.plots[0]
    first plot
    
    or by its position in the grid:
    
    >>> chart.plots[0, 1]
    plot at row=0, column=1
    
    @param number: chart number; by default this a L{Chart.AUTONUMBER}
    @type number: int or None
    @param title: chart master title
    @type title: str
    @param rows: number of rows in the chart window
    @type rows: int
    @param columns: number of columns in the chart window
    @type columns: int
    
    @note: additional arguments are passed directly to Matplotlib's Figure
           constructor. 
    """

    AUTONUMBER = None
    
    _serial = 0
    
    
    def __init__(self, number=None, title='', rows=1, columns=1, backend=Backends.WX_WIDGETS, *fa, **fk):
        
        if number == Chart.AUTONUMBER:
            Chart._serial += 1
            number = Chart._serial
        
        if rows < 1:
            rows = 1
        if columns < 1:
            columns = 1
            
        self._rows = int(rows)
        self._columns = int(columns)
        self._number = int(number)
        self._title = str(title)
        self._figure = Figure(*fa, **fk)
        self._figure._figure_number = self._number
        self._figure.suptitle(self._title)
        self._beclass = backend
        self._hasgui = False
        self._plots = PlotsCollection(self._figure, self._rows, self._columns)        
        self._canvas = FigureCanvasAgg(self._figure)
        
        formats = [ (f.upper(), f) for f in self._canvas.get_supported_filetypes() ]
        self._formats = csb.core.Enum.create('OutputFormats', **dict(formats))
    
    def __getitem__(self, i):
        if i in self._plots:
            return self._plots[i]
        else:
            raise KeyError('No such plot number: {0}'.format(i))
        
    def __enter__(self):
        return self
    
    def __exit__(self, *a, **k):
        self.dispose()
    
    @property
    def _backend(self):
        return Backend.get(self._beclass, started=True)

    @property
    def _backend_started(self):
        return Backend.query(self._beclass)
      
    @property
    def title(self):
        """
        Chart title
        @rtype: str
        """
        return self._title
        
    @property
    def number(self):
        """
        Chart number
        @rtype: int
        """        
        return self._number
    
    @property
    def plots(self):
        """
        Index-based access to the plots in this chart
        @rtype: L{PlotsCollection}
        """
        return self._plots
    
    @property
    def plot(self):
        """
        First plot
        @rtype: matplotlib.AxesSubplot
        """
        return self._plots[0]
    
    @property
    def rows(self):
        """
        Number of rows in this chart
        @rtype: int
        """
        return self._rows
    
    @property
    def columns(self):
        """
        Number of columns in this chart
        @rtype: int
        """        
        return self._columns
    
    @property
    def width(self):
        """
        Chart's width in inches
        @rtype: int
        """
        return self._figure.get_figwidth()
    @width.setter
    def width(self, inches):
        self._figure.set_figwidth(inches)
        if self._backend_started:
            self._backend.resize(self._figure)

    @property
    def height(self):
        """
        Chart's height in inches
        @rtype: int
        """        
        return self._figure.get_figheight()
    @height.setter
    def height(self, inches):
        self._figure.set_figheight(inches)
        if self._backend_started:
            self._backend.resize(self._figure)
                
    @property
    def dpi(self):
        """
        Chart's DPI
        @rtype: int
        """        
        return self._figure.get_dpi()
    @dpi.setter
    def dpi(self, dpi):
        self._figure.set_dpi(dpi)
        self._backend.resize(self._figure)
            
    @property
    def formats(self):
        """
        Supported output file formats
        @rtype: L{csb.core.enum}
        """
        return self._formats
            
    def show(self):
        """
        Show the GUI window (non-blocking).
        """
        if not self._hasgui:
            self._backend.add(self._figure)
            self._hasgui = True
            
        self._backend.show(self._figure)
                
    def hide(self):
        """
        Hide (but do not dispose) the GUI window.
        """
        self._backend.hide(self._figure)
        
    def dispose(self):
        """
        Dispose the GUI interface. Must be called at the end if any
        chart.show() calls have been made. Automatically called if using
        the chart in context manager ("with" statement).
        
        @note: Failing to call this method if show() has been called at least
        once may cause backend-related errors.
        """
        if self._backend_started:
        
            service = self._backend
            
            if service and service.running:
                service.destroy(self._figure, wait=True)
                service.client_disposed(self)    
        
    def save(self, file, format='png', crop=False, dpi=None, *a, **k):
        """
        Save all plots to an image.
        
        @param file: destination file name
        @type file: str
        @param format: output image format; see C{chart.formats} for enumeration
        @type format: str or L{csb.core.EnumItem}
        @param crop: if True, crop the image (equivalent to MPL's bbox=tight)
        @type crop: bool
                
        @note: additional arguments are passed directly to MPL's savefig method
        """
        if 'bbox_inches' in k:
            bbox = k['bbox_inches']
            del k['bbox_inches']
        else:
            if crop:
                bbox = 'tight'
            else:
                bbox = None
            
        self._canvas.print_figure(file, format=str(format), bbox_inches=bbox, dpi=dpi, *a, **k)