source: sasview/sansguiframe/src/sans/guiframe/local_perspectives/plotting/boxSlicer.py @ 886657f

import wx
#import copy
#from copy import deepcopy
import math
import numpy
from sans.guiframe.events import NewPlotEvent
from sans.guiframe.events import StatusEvent
from sans.guiframe.events import SlicerParameterEvent
from sans.guiframe.events import EVT_SLICER_PARS
from BaseInteractor import _BaseInteractor
from sans.guiframe.dataFitting import Data1D
#import SlicerParameters


class BoxInteractor(_BaseInteractor):
    """
    BoxInteractor define a rectangle that return data1D average of Data2D
    in a rectangle area defined by -x, x ,y, -y
    """
    def __init__(self, base, axes, color='black', zorder=3):
        _BaseInteractor.__init__(self, base, axes, color=color)
        ## Class initialization
        self.markers = []
        self.axes = axes
        ##connecting artist
        self.connect = self.base.connect
        ## determine x y  values
        self.x = 0.5 * min(math.fabs(self.base.data2D.xmax),
                           math.fabs(self.base.data2D.xmin))
        self.y = 0.5 * min(math.fabs(self.base.data2D.xmax),
                           math.fabs(self.base.data2D.xmin))        
        ## when reach qmax reset the graph
        self.qmax = max(self.base.data2D.xmax, self.base.data2D.xmin,
                        self.base.data2D.ymax, self.base.data2D.ymin)   
        ## Number of points on the plot
        self.nbins = 30
        ## If True, I(|Q|) will be return, otherwise,
        #negative q-values are allowed
        self.fold = True        
        ## reference of the current  Slab averaging
        self.averager = None
        ## Create vertical and horizaontal lines for the rectangle
        self.vertical_lines = VerticalLines(self,
                                            self.base.subplot, 
                                            color='blue', 
                                            zorder=zorder,
                                            y=self.y ,
                                            x=self.x)
        self.vertical_lines.qmax = self.qmax
       
        self.horizontal_lines = HorizontalLines(self,
                                               self.base.subplot,
                                               color='green', 
                                               zorder=zorder,
                                               x=self.x,
                                               y=self.y)
        self.horizontal_lines.qmax = self.qmax
        ## draw the rectangle and plost the data 1D resulting
        ## of averaging data2D
        self.update()
        self._post_data()
        ## Bind to slice parameter events
        self.base.Bind(EVT_SLICER_PARS, self._onEVT_SLICER_PARS)

    def _onEVT_SLICER_PARS(self, event):
        """
        receive an event containing parameters values to reset the slicer
        
        :param event: event of type SlicerParameterEvent with params as 
            attribute
        """
        wx.PostEvent(self.base.parent,
                     StatusEvent(status="BoxSlicer._onEVT_SLICER_PARS"))
        event.Skip()
        if event.type == self.__class__.__name__:
            self.set_params(event.params)
            self.base.update()
            
    def update_and_post(self):
        """
        Update the slicer and plot the resulting data
        """
        self.update()
        self._post_data()
        
    def set_layer(self, n):
        """
        Allow adding plot to the same panel
        
        :param n: the number of layer
        
        """
        self.layernum = n
        self.update()
        
    def clear(self):
        """
        Clear the slicer and all connected events related to this slicer
        """
        self.averager = None
        self.clear_markers()
        self.horizontal_lines.clear()
        self.vertical_lines.clear()
        self.base.connect.clearall()
        self.base.Unbind(EVT_SLICER_PARS)
        
    def update(self):
        """
        Respond to changes in the model by recalculating the profiles and
        resetting the widgets.
        """
        ##Update the slicer if an horizontal line is dragged   
        if self.horizontal_lines.has_move:
            self.horizontal_lines.update()
            self.vertical_lines.update(y=self.horizontal_lines.y)
        ##Update the slicer if a vertical line is dragged    
        if self.vertical_lines.has_move:
            self.vertical_lines.update()
            self.horizontal_lines.update(x=self.vertical_lines.x)
                 
    def save(self, ev):
        """
        Remember the roughness for this layer and the next so that we
        can restore on Esc.
        """
        self.base.freeze_axes()
        self.vertical_lines.save(ev)
        self.horizontal_lines.save(ev)
    
    def _post_data(self):
        pass
        
    def post_data(self, new_slab=None, nbins=None, direction=None):
        """
        post data averaging in Qx or Qy given new_slab type
        
        :param new_slab: slicer that determine with direction to average
        :param nbins: the number of points plotted when averaging
        :param direction: the direction of averaging
        
        """
        x_min = -1 * math.fabs(self.vertical_lines.x)
        x_max = math.fabs(self.vertical_lines.x)
        y_min = -1 * math.fabs(self.horizontal_lines.y)
        y_max = math.fabs(self.horizontal_lines.y)
        
        if nbins != None:
            self.nbins = nbins
        if self.averager == None:
            if new_slab == None:
                msg = "post data:cannot average , averager is empty"
                raise ValueError, msg
            self.averager = new_slab
        if direction == "X":
            if self.fold:
                x_low = 0
            else:
                x_low = math.fabs(x_min)
            bin_width = (x_max + x_low)/self.nbins
        else:
            if self.fold:
                y_low = 0
            else:
                y_low = math.fabs(y_min)
            bin_width = (y_max + y_low)/self.nbins
        ## Average data2D given Qx or Qy
        box = self.averager(x_min=x_min, x_max=x_max, y_min=y_min, y_max=y_max,
                         bin_width=bin_width)
        box.fold = self.fold
        boxavg = box(self.base.data2D)
        #3 Create Data1D to plot
        if hasattr(boxavg, "dxl"):
            dxl = boxavg.dxl
        else:
            dxl = None
        if hasattr(boxavg, "dxw"):
            dxw = boxavg.dxw
        else:
            dxw = None
        new_plot = Data1D(x=boxavg.x, y=boxavg.y, dy=boxavg.dy)
        new_plot.dxl  = dxl
        new_plot.dxw  = dxw
        new_plot.name = str(self.averager.__name__) + \
                        "(" + self.base.data2D.name + ")"
        new_plot.source = self.base.data2D.source
        new_plot.interactive = True
        new_plot.detector = self.base.data2D.detector
        ## If the data file does not tell us what the axes are, just assume...
        new_plot.xaxis("\\rm{Q}", "A^{-1}")
        new_plot.yaxis("\\rm{Intensity} ", "cm^{-1}")

        data = self.base.data2D
        if hasattr(data, "scale") and data.scale == 'linear' and \
                self.base.data2D.name.count("Residuals") > 0:
            new_plot.ytransform = 'y'
            new_plot.yaxis("\\rm{Residuals} ", "/")
            
        new_plot.group_id = str(self.averager.__name__) + self.base.data2D.name
        #new_plot.id = str(self.averager.__name__)
        #new_plot.is_data= True
        wx.PostEvent(self.base.parent, NewPlotEvent(plot=new_plot,
                                title=str(self.averager.__name__)))
          
    def moveend(self, ev):
        """
        Called after a dragging event.
        Post the slicer new parameters and creates a new Data1D 
        corresponding to the new average
        """
        self.base.thaw_axes()
        # Post paramters
        event = SlicerParameterEvent()
        event.type = self.__class__.__name__
        event.params = self.get_params()
        wx.PostEvent(self.base.parent, event)
        # create the new data1D
        self._post_data()
            
    def restore(self):
        """
        Restore the roughness for this layer.
        """
        self.horizontal_lines.restore()
        self.vertical_lines.restore()
       
    def move(self, x, y, ev):
        """
        Process move to a new position, making sure that the move is allowed.
        """
        pass
        
    def set_cursor(self, x, y):
        pass
        
    def get_params(self):
        """
        Store a copy of values of parameters of the slicer into a dictionary.
        
        :return params: the dictionary created
        
        """
        params = {}
        params["x_max"] = math.fabs(self.vertical_lines.x)
        params["y_max"] = math.fabs(self.horizontal_lines.y)
        params["nbins"] = self.nbins
        return params
    
    def set_params(self, params):
        """
        Receive a dictionary and reset the slicer with values contained 
        in the values of the dictionary.
        
        :param params: a dictionary containing name of slicer parameters and 
            values the user assigned to the slicer.
        """
        self.x = float(math.fabs(params["x_max"]))
        self.y = float(math.fabs(params["y_max"] ))
        self.nbins = params["nbins"]
        
        self.horizontal_lines.update(x=self.x, y=self.y)
        self.vertical_lines.update(x=self.x, y=self.y)
        self.post_data(nbins=None)
        
    def freeze_axes(self):
        """
        """
        self.base.freeze_axes()
        
    def thaw_axes(self):
        """
        """
        self.base.thaw_axes()

    def draw(self):
        """
        """
        self.base.draw()


class HorizontalLines(_BaseInteractor):
    """
    Draw 2 Horizontal lines centered on (0,0) that can move 
    on the x- direction and in opposite direction
    """
    def __init__(self, base, axes, color='black', zorder=5, x=0.5, y=0.5):
        """
        """
        _BaseInteractor.__init__(self, base, axes, color=color)
        ##Class initialization
        self.markers = []
        self.axes = axes
        ## Saving the end points of two lines
        self.x = x
        self.save_x = x
        
        self.y = y
        self.save_y = y
        ## Creating a marker
        try:
            # Inner circle marker
            self.inner_marker = self.axes.plot([0], [self.y], linestyle='',
                                          marker='s', markersize=10,
                                          color=self.color, alpha=0.6,
                                          pickradius=5, label="pick", 
                                          # Prefer this to other lines
                                          zorder=zorder, 
                                          visible=True)[0]
        except:
            self.inner_marker = self.axes.plot([0], [self.y], linestyle='',
                                          marker='s', markersize=10,
                                          color=self.color, alpha=0.6,
                                          label="pick", visible=True)[0]
            message  = "\nTHIS PROTOTYPE NEEDS THE LATEST VERSION "
            message += "OF MATPLOTLIB\n Get the SVN version that"
            message += " is at least as recent as June 1, 2007"
            owner = self.base.base.parent
            wx.PostEvent(owner,
                         StatusEvent(status="AnnulusSlicer: %s" % message))
        ## Define 2 horizontal lines
        self.top_line = self.axes.plot([self.x, -self.x], [self.y, self.y],
                                      linestyle='-', marker='',
                                      color=self.color, visible=True)[0]
        self.bottom_line = self.axes.plot([self.x, -self.x], [-self.y, -self.y],
                                      linestyle='-', marker='',
                                      color=self.color, visible=True)[0]
        ## Flag to check the motion of the lines
        self.has_move = False
        ## Connecting markers to mouse events and draw
        self.connect_markers([self.top_line, self.inner_marker])
        self.update()

    def set_layer(self, n):
        """
        Allow adding plot to the same panel
        
        :param n: the number of layer
        
        """
        self.layernum = n
        self.update()
        
    def clear(self):
        """
        Clear this slicer  and its markers
        """
        self.clear_markers()
        try:
            self.inner_marker.remove()
            self.top_line.remove() 
            self.bottom_line.remove()
        except:
            # Old version of matplotlib
            for item in range(len(self.axes.lines)):
                del self.axes.lines[0]
   
    def update(self, x=None, y=None):
        """
        Draw the new roughness on the graph.
        
        :param x: x-coordinates to reset current class x
        :param y: y-coordinates to reset current class y
        
        """
        ## Reset x, y- coordinates if send as parameters
        if x != None:
            self.x = numpy.sign(self.x) * math.fabs(x)
        if y != None:
            self.y = numpy.sign(self.y) * math.fabs(y)
        ## Draw lines and markers
        self.inner_marker.set(xdata=[0], ydata=[self.y])
        self.top_line.set(xdata=[self.x, -self.x], ydata=[self.y, self.y])
        self.bottom_line.set(xdata=[self.x,-self.x], ydata=[-self.y, -self.y])
        
    def save(self, ev):
        """
        Remember the roughness for this layer and the next so that we
        can restore on Esc.
        """
        self.save_x = self.x
        self.save_y = self.y
        self.base.freeze_axes()

    def moveend(self, ev):
        """
        Called after a dragging this edge and set self.has_move to False
        to specify the end of dragging motion
        """
        self.has_move = False
        self.base.moveend(ev)
             
    def restore(self):
        """
        Restore the roughness for this layer.
        """
        self.x = self.save_x
        self.y = self.save_y
        
    def move(self, x, y, ev):
        """
        Process move to a new position, making sure that the move is allowed.
        """
        self.y = y
        self.has_move = True
        self.base.base.update()
        
  
class VerticalLines(_BaseInteractor):
    """
    Select an annulus through a 2D plot
    """
    def __init__(self, base, axes, color='black', zorder=5, x=0.5, y=0.5):
        """
        """
        _BaseInteractor.__init__(self, base, axes, color=color)
        self.markers = []
        self.axes = axes
        self.x = math.fabs(x)
        self.save_x = self.x
        self.y = math.fabs(y)
        self.save_y = y
        try:
            # Inner circle marker
            self.inner_marker = self.axes.plot([self.x], [0], linestyle='',
                                          marker='s', markersize=10,
                                          color=self.color, alpha=0.6,
                                          pickradius=5, label="pick", 
                                          # Prefer this to other lines
                                          zorder=zorder, visible=True)[0]
        except:
            self.inner_marker = self.axes.plot([self.x], [0], linestyle='',
                                          marker='s', markersize=10,
                                          color=self.color, alpha=0.6,
                                          label="pick", visible=True)[0]
            message  = "\nTHIS PROTOTYPE NEEDS THE LATEST VERSION"
            message += " OF MATPLOTLIB\n Get the SVN version that is"
            message += " at least as recent as June 1, 2007"
            
        self.right_line = self.axes.plot([self.x, self.x],
                                         [self.y , -self.y],
                                      linestyle='-', marker='',
                                      color=self.color, visible=True)[0]
        self.left_line = self.axes.plot([-self.x, -self.x],
                                        [self.y, -self.y],
                                      linestyle='-', marker='',
                                      color=self.color, visible=True)[0]
        self.has_move = False
        self.connect_markers([self.right_line, self.inner_marker])
        self.update()

    def set_layer(self, n):
        """
        Allow adding plot to the same panel
        
        :param n: the number of layer
        
        """
        self.layernum = n
        self.update()
        
    def clear(self):
        """
        Clear this slicer  and its markers
        """
        self.clear_markers()
        try:
            self.inner_marker.remove()
            self.left_line.remove()
            self.right_line.remove()
        except:
            # Old version of matplotlib
            for item in range(len(self.axes.lines)):
                del self.axes.lines[0]

    def update(self, x=None, y=None):
        """
        Draw the new roughness on the graph.
        
        :param x: x-coordinates to reset current class x
        :param y: y-coordinates to reset current class y
        
        """
        ## reset x, y -coordinates if given as parameters
        if x != None:
            self.x = numpy.sign(self.x) * math.fabs(x)
        if y != None:
            self.y = numpy.sign(self.y) * math.fabs(y)
        ## draw lines and markers  
        self.inner_marker.set(xdata=[self.x], ydata=[0]) 
        self.left_line.set(xdata=[-self.x, -self.x], ydata=[self.y, -self.y]) 
        self.right_line.set(xdata=[self.x, self.x], ydata=[self.y, -self.y]) 
    
    def save(self, ev):
        """
        Remember the roughness for this layer and the next so that we
        can restore on Esc.
        """
        self.save_x = self.x
        self.save_y = self.y
        self.base.freeze_axes()
        
    def moveend(self, ev):
        """
        Called after a dragging this edge and set self.has_move to False
        to specify the end of dragging motion
        """
        self.has_move = False
        self.base.moveend(ev)
               
    def restore(self):
        """
        Restore the roughness for this layer.
        """
        self.x = self.save_x
        self.y = self.save_y
      
    def move(self, x, y, ev):
        """
        Process move to a new position, making sure that the move is allowed.
        """
        self.has_move = True
        self.x = x
        self.base.base.update()
        
   
class BoxInteractorX(BoxInteractor):
    """
    Average in Qx direction
    """
    def __init__(self, base, axes, color='black', zorder=3):
        BoxInteractor.__init__(self, base, axes, color=color)
        self.base = base
        self._post_data()
        
    def _post_data(self):
        """
        Post data creating by averaging in Qx direction
        """
        from sans.dataloader.manipulations import SlabX
        self.post_data(SlabX, direction="X")   
        

class BoxInteractorY(BoxInteractor):
    """
    Average in Qy direction
    """
    def __init__(self, base, axes, color='black', zorder=3):
        BoxInteractor.__init__(self, base, axes, color=color)
        self.base = base
        self._post_data()
        
    def _post_data(self):
        """
        Post data creating by averaging in Qy direction
        """
        from sans.dataloader.manipulations import SlabY
        self.post_data(SlabY, direction="Y")