source: sasview/guiframe/local_perspectives/plotting/Plotter1D.py @ e5c6fff

"""
This software was developed by the University of Tennessee as part of the
Distributed Data Analysis of Neutron Scattering Experiments (DANSE)
project funded by the US National Science Foundation. 

See the license text in license.txt

copyright 2008, University of Tennessee
"""


import wx
import sys, os
import pylab, time,numpy

import danse.common.plottools
from danse.common.plottools.PlotPanel import PlotPanel
from danse.common.plottools.plottables import Graph,Theory1D
from sans.guiframe import dataFitting 
from sans.guicomm.events import EVT_NEW_PLOT
from sans.guicomm.events import StatusEvent ,NewPlotEvent,SlicerEvent,ErrorDataEvent
from sans.guicomm.events import RemoveDataEvent
from sans.guiframe.utils import PanelMenu

from binder import BindArtist


DEFAULT_QMAX = 0.05
DEFAULT_QSTEP = 0.001
DEFAULT_BEAM = 0.005
BIN_WIDTH =1


class ModelPanel1D(PlotPanel):
    """
        Plot panel for use with the GUI manager
    """
    
    ## Internal name for the AUI manager
    window_name = "plotpanel"
    ## Title to appear on top of the window
    window_caption = "Plot Panel"
    ## Flag to tell the GUI manager that this panel is not
    #  tied to any perspective
    ALWAYS_ON = True
    ## Group ID
    group_id = None
    
    def __init__(self, parent, id = -1, color = None,\
        dpi = None, style = wx.NO_FULL_REPAINT_ON_RESIZE, **kwargs):
        """
            Initialize the panel
        """
        PlotPanel.__init__(self, parent, id = id, style = style, **kwargs)
        
        ## Reference to the parent window
        self.parent = parent
        ## Plottables
        self.plots = {}
        ## save errors dy  for each data plotted
        self.err_dy={}
        ## flag to determine if the hide or show context menu item should
        ## be displayed
        self.errors_hide=False
        ## Unique ID (from gui_manager)
        self.uid = None
        ## Action IDs for internal call-backs
        self.action_ids = {}
        ## Default locations
        self._default_save_location = os.getcwd()        
        ## Graph        
        self.graph = Graph()
        self.graph.xaxis("\\rm{Q}", 'A^{-1}')
        self.graph.yaxis("\\rm{Intensity} ","cm^{-1}")
        self.graph.render(self)
   
   
    def _reset(self):
        """
            Resets internal data and graph
        """    
        self.graph.reset()
        self.plots      = {}
        self.action_ids = {}
    
    
    def _onEVT_1DREPLOT(self, event):
        """
            Data is ready to be displayed
            @param event: data event
        """
       
        #TODO: Check for existence of plot attribute
        # Check whether this is a replot. If we ask for a replot
        # and the plottable no longer exists, ignore the event.
        if hasattr(event, "update") and event.update==True \
            and event.plot.name not in self.plots.keys():
            return
        
        if hasattr(event, "reset"):
            self._reset()
        
        is_new = True
        if event.plot.name in self.plots.keys():
            # Check whether the class of plottable changed
            if not event.plot.__class__==self.plots[event.plot.name].__class__:
                #overwrite a plottable using the same name
                self.graph.delete(self.plots[event.plot.name])
            else:
                # plottable is already draw on the panel
                is_new = False
        
        if is_new:
            # a new plottable overwrites a plotted one  using the same id
            for plottable in self.plots.itervalues():
                if hasattr(event.plot,"id") and hasattr(plottable, "id"):
                    if event.plot.id==plottable.id :
                        self.graph.delete(plottable)
            
            self.plots[event.plot.name] = event.plot
            self.graph.add(self.plots[event.plot.name])
        else:
            #replot the graph
            self.plots[event.plot.name].x = event.plot.x    
            self.plots[event.plot.name].y = event.plot.y    
            self.plots[event.plot.name].dy = event.plot.dy  
            if hasattr(event.plot, 'dx') and hasattr(self.plots[event.plot.name], 'dx'):
                self.plots[event.plot.name].dx = event.plot.dx    
          
        #TODO: Should re-factor this
        ## for all added plot the option to hide error show be displayed first
        #self.errors_hide = 0
        ## Set axis labels
        self.graph.xaxis(event.plot._xaxis, event.plot._xunit)
        self.graph.yaxis(event.plot._yaxis, event.plot._yunit)
        ## Set the view scale for all plots
        self._onEVT_FUNC_PROPERTY()
        ## render the graph
        self.graph.render(self)
        self.subplot.figure.canvas.draw_idle()
        if self.errors_hide:
            self._on_remove_errors(evt=None)
        else:
            self._on_add_errors( evt=None)
        return
    
    def onLeftDown(self,event): 
        """ 
            left button down and ready to drag
            Display the position of the mouse on the statusbar
        """
        PlotPanel.onLeftDown(self, event)
        ax = event.inaxes
        if ax != None:
            position = "x: %8.3g    y: %8.3g" % (event.xdata, event.ydata)
            wx.PostEvent(self.parent, StatusEvent(status=position))


    def _onRemove(self, event):
        """
            Remove a plottable from the graph and render the graph 
            @param event: Menu event
        """
        ## Check if there is a selected graph to remove
        if not self.graph.selected_plottable == None and\
            self.graph.selected_plottable in self.plots.keys():
            color=self.graph.plottables[self.plots[self.graph.selected_plottable]]
           
            event = RemoveDataEvent(data =self.plots[self.graph.selected_plottable])
            wx.PostEvent(self.parent, event)
            self.graph.delete(self.plots[self.graph.selected_plottable])
            del self.plots[self.graph.selected_plottable]
            ## increment graph color
            self.graph.color += color
            self.graph.render(self)
            self.subplot.figure.canvas.draw_idle()    
           
            

    def onContextMenu(self, event):
        """
            1D plot context menu
            @param event: wx context event
        """
        slicerpop = PanelMenu()
        slicerpop.set_plots(self.plots)
        slicerpop.set_graph(self.graph)
                
        # Various plot options
        id = wx.NewId()
        slicerpop.Append(id,'&Save image', 'Save image as PNG')
        wx.EVT_MENU(self, id, self.onSaveImage)
        
        id = wx.NewId()
        slicerpop.Append(id,'&Print image', 'Print image ')
        wx.EVT_MENU(self, id, self.onPrint)
          
        id = wx.NewId()
        slicerpop.Append(id,'&Print Preview', 'image preview for print')
        wx.EVT_MENU(self, id, self.onPrinterPreview)
           
        slicerpop.AppendSeparator()
        item_list = self.parent.get_context_menu(self.graph)
       
        if (not item_list==None) and (not len(item_list)==0):
            for item in item_list:
                try:
                    id = wx.NewId()
                    slicerpop.Append(id, item[0], item[1])
                    wx.EVT_MENU(self, id, item[2])
                except:
                    wx.PostEvent(self.parent, StatusEvent(status=\
                        "ModelPanel1D.onContextMenu: bad menu item  %s"%sys.exc_value))
                    pass
            slicerpop.AppendSeparator()
        
        if self.graph.selected_plottable in self.plots:
            plot = self.plots[self.graph.selected_plottable]
            id = wx.NewId()
            name = plot.name
           
            slicerpop.Append(id, "&Save points" )
            self.action_ids[str(id)] = plot
            wx.EVT_MENU(self, id, self._onSave)
          
            id = wx.NewId()
            slicerpop.Append(id, "Remove %s curve" % name)
            self.action_ids[str(id)] = plot
            wx.EVT_MENU(self, id, self._onRemove)
            slicerpop.AppendSeparator()
            # Option to hide
            #TODO: implement functionality to hide a plottable (legend click)
       
        if self.graph.selected_plottable in self.plots:
            selected_plot= self.plots[self.graph.selected_plottable]
            #if self.plots[self.graph.selected_plottable].name in self.err_dy.iterkeys()\
            #    and self.errors_hide:
            if selected_plot.__class__.__name__=="Data1D":
                if selected_plot.dy ==None or selected_plot.dy== []:
                    id = wx.NewId()
                    slicerpop.Append(id, '&Show errors to data')
                    wx.EVT_MENU(self, id, self._on_add_errors)
                elif numpy.all(selected_plot.dy==0):
                    id = wx.NewId()
                    slicerpop.Append(id, '&Show errors to data')
                    wx.EVT_MENU(self, id, self._on_add_errors)
                else:
                    id = wx.NewId()
                    slicerpop.Append(id, '&Hide Error bars')
                    wx.EVT_MENU(self, id, self._on_remove_errors)
            
            id = wx.NewId()
            slicerpop.Append(id, '&Linear fit')
            wx.EVT_MENU(self, id, self.onFitting)
                
            slicerpop.AppendSeparator()
        
        id = wx.NewId()
        slicerpop.Append(id, '&Change scale')
        wx.EVT_MENU(self, id, self._onProperties)
       
        id = wx.NewId()
        slicerpop.Append(id, '&Reset Graph')
        wx.EVT_MENU(self, id, self.onResetGraph)  
       
        pos = event.GetPosition()
        pos = self.ScreenToClient(pos)
        self.PopupMenu(slicerpop, pos)
        
        
    def _on_remove_errors(self, evt):
        """
            Save name and dy of data in dictionary self.err_dy
            Create a new data1D with the same x, y
            vector and dy with zeros.
            post self.err_dy as event (ErrorDataEvent) for any object
            which wants to reconstruct the initial data.
            @param evt: Menu event
        """
        if not self.graph.selected_plottable == None:
            ## store existing dy
            name =self.plots[self.graph.selected_plottable].name
            dy = self.plots[self.graph.selected_plottable].dy
            self.err_dy[name]= dy
            ## Create a new dy for a new plottable
            import numpy
            dy= numpy.zeros(len(self.plots[self.graph.selected_plottable].y))
            selected_plot= self.plots[self.graph.selected_plottable]
            
            if selected_plot.__class__.__name__=="Data1D":
                # Make sure that we can pass a basic Data1D
                dxl = None
                dxw = None
                if hasattr(selected_plot, "dxl"):
                    dxl = selected_plot.dxl
                if hasattr(selected_plot, "dxw"):
                    dxw = selected_plot.dxw
                new_plot = dataFitting.Data1D( x=selected_plot.x,
                              y= selected_plot.y,
                               dx=selected_plot.dx,
                              dy=dy,
                              dxl=dxl,
                              dxw=dxw)
                            
            else:
                 new_plot = Theory1D(x=selected_plot.x,y=selected_plot.y,dy=dy)
            new_plot.interactive = True
            self.errors_hide = True
            new_plot.name = self.plots[self.graph.selected_plottable].name 
            if hasattr(self.plots[self.graph.selected_plottable], "group_id"):
                new_plot.group_id = self.plots[self.graph.selected_plottable].group_id
                new_plot.id = self.plots[self.graph.selected_plottable].id
            else:
                new_plot.group_id = str(time.time())
                new_plot.id = str(time.time())
            label, unit = self.plots[self.graph.selected_plottable].get_xaxis()
            new_plot.xaxis(label, unit)
            label, unit = self.plots[self.graph.selected_plottable].get_yaxis()
            new_plot.yaxis(label, unit)
            ## save the color of the selected plottable before it is deleted
            color=self.graph.plottables[self.plots[self.graph.selected_plottable]]
            self.graph.delete(self.plots[self.graph.selected_plottable])
            ## add newly created plottable to the graph with the save color
            self.graph.color += color
            self.graph.add(new_plot,color)
            ## transforming the view of the new data into the same of the previous data
            self._onEVT_FUNC_PROPERTY()
            ## save the plot 
            self.plots[self.graph.selected_plottable]=new_plot
            ## Render the graph
            self.graph.render(self)
            self.subplot.figure.canvas.draw_idle() 
            
            event = ErrorDataEvent(err_dy=self.err_dy)
            wx.PostEvent(self.parent, event)
    
    
    def _on_add_errors(self, evt):
        """
            create a new data1D witht the errors saved in self.err_dy
            to show errors of the plot.
            Compute reasonable errors for a data set without 
            errors and transorm the plottable to a Data1D
            @param evt: Menu event
        """
        import math
        import numpy
        import time
        
        if not self.graph.selected_plottable == None \
            and self.graph.selected_plottable in self.plots.keys():
            ##Reset the flag to display the hide option on the context menu
            self.errors_hide = False
            ## restore dy 
            length = len(self.plots[self.graph.selected_plottable].x)
            dy = numpy.zeros(length)
            
            selected_plot= self.plots[self.graph.selected_plottable]
            
            try:
                dy = self.err_dy[selected_plot.name]
               
            except:
                #for i in range(length):
                #dy[i] = math.sqrt(self.plots[self.graph.selected_plottable].y[i])      
                if hasattr(selected_plot,"dy"):
                    dy= selected_plot.dy
                else:
                    dy = numpy.zeros(selected_plot.dy)
                    
            ## Create a new plottable data1D
            if selected_plot.__class__.__name__=="Data1D":
                # Make sure that we can pass a basic Data1D
                dxl = None
                dxw = None
                if hasattr(selected_plot, "dxl"):
                    dxl = selected_plot.dxl
                if hasattr(selected_plot, "dxw"):
                    dxw = selected_plot.dxw
                new_plot = dataFitting.Data1D( x=selected_plot.x,
                                               y= selected_plot.y,
                                               dx=selected_plot.dx,
                                               dy=dy,
                                               dxl=dxl,
                                               dxw=dxw)
            else:
                ## Create a new plottable Theory1D
                new_plot = Theory1D(x=selected_plot.x,y=selected_plot.y,dy=dy)
            
            new_plot.interactive = True
            new_plot.name = self.plots[self.graph.selected_plottable].name 
            if hasattr(self.plots[self.graph.selected_plottable], "group_id"):
                new_plot.group_id = self.plots[self.graph.selected_plottable].group_id
                new_plot.id = self.plots[self.graph.selected_plottable].id
            else:
                new_plot.group_id = str(time.time())
                new_plot.id = str(time.time())
            
            label, unit = self.plots[self.graph.selected_plottable].get_xaxis()
            new_plot.xaxis(label, unit)
            label, unit = self.plots[self.graph.selected_plottable].get_yaxis()
            new_plot.yaxis(label, unit)
            ## save the color of the selected plottable before it is deleted
            color=self.graph.plottables[self.plots[self.graph.selected_plottable]]
            self.graph.delete(self.plots[self.graph.selected_plottable])
            self.graph.color += color
            ## add newly created plottable to the graph with the save color
            self.graph.add(new_plot, color)
            ## transforming the view of the new data into the same of the previous data
            self._onEVT_FUNC_PROPERTY()
            ## save the plot 
            self.plots[self.graph.selected_plottable]=new_plot
            ## render the graph with its new content
            self.graph.render(self)
            self.subplot.figure.canvas.draw_idle() 
               
               
    def _onSaveXML(self, path):
        """
            Save 1D  Data to  XML file
            
            TODO: Refactor and remove this method. See TODO in _onSave.
            
            @param evt: Menu event
        """
        if not path == None:
            out = open(path, 'w')
            from DataLoader.readers import cansas_reader
            reader = cansas_reader.Reader()
            datainfo= self.plots[self.graph.selected_plottable].info
            reader.write( path, datainfo)
           
            try:
                self._default_save_location = os.path.dirname(path)
            except:
                pass
        
        return 
    
    
    def _onsaveTXT(self, path):
        """
            Save file as txt
            
            TODO: Refactor and remove this method. See TODO in _onSave.
        """
        data = self.plots[self.graph.selected_plottable]
       
        if not path == None:
            out = open(path, 'w')
            has_errors = True
            if data.dy==None or data.dy==[]:
                has_errors = False
                
            # Sanity check
            if has_errors:
                try:
                    if len(data.y) != len(data.dy):

                        has_errors = False
                except:
                    has_errors = False
            
            if has_errors:
                out.write("<X>   <Y>   <dY>\n")
            else:
                out.write("<X>   <Y>\n")
                
            for i in range(len(data.x)):
                if has_errors:
                    out.write("%g  %g  %g\n" % (data.x[i], 
                                                data.y[i],
                                               data.dy[i]))
                else:
                    out.write("%g  %g\n" % (data.x[i], 
                                            data.y[i]))
                    
            out.close()                 
            try:
                self._default_save_location = os.path.dirname(path)
            except:
                pass    
                
    def _onSave(self, evt):
        """
            Save a data set to a text file
            @param evt: Menu event
        """
        import os
        id = str(evt.GetId())
        if id in self.action_ids:         
            
            path = None
            wildcard = "Text files (*.txt)|*.txt|"\
            "CanSAS 1D files(*.xml)|*.xml" 
            dlg = wx.FileDialog(self, "Choose a file",
                                self._default_save_location, "",wildcard , wx.SAVE)
           
            if dlg.ShowModal() == wx.ID_OK:
                path = dlg.GetPath()
                mypath = os.path.basename(path)
                
                #TODO: This is bad design. The DataLoader is designed to recognize extensions.
                # It should be a simple matter of calling the .save(file, data, '.xml') method
                # of the DataLoader.loader.Loader class. 
                
                if os.path.splitext(mypath)[1].lower() ==".txt":
                    self._onsaveTXT(path)
                if os.path.splitext(mypath)[1].lower() ==".xml":
                    self._onSaveXML(path)
            
            dlg.Destroy()