Changeset d620d03c in sasview for src/sas/sasgui/perspectives

Timestamp:

Apr 1, 2019 9:35:50 PM (6 years ago)

Author:

GitHub <noreply@…>

Parents:

fa307dd (diff), 0dde203 (diff)
Note: this is a merge changeset, the changes displayed below correspond to the merge itself.
Use the (diff) links above to see all the changes relative to each parent.

git-author:

Paul Kienzle <pkienzle@…> (04/01/19 21:35:50)

git-committer:

GitHub <noreply@…> (04/01/19 21:35:50)

Message:

Merge 0dde203f515bdd11871b41ee8734237ad1296b87 into fa307ddb8d25a41b44c02bd525f9727d5b4b7e5b

Location:

src/sas/sasgui/perspectives

Files:

• calculator/data_editor.py (modified) (3 diffs)
• calculator/data_operator.py (modified) (1 diff)
• calculator/gen_scatter_panel.py (modified) (26 diffs)
• calculator/image_viewer.py (modified) (4 diffs)
• corfunc/corfunc_panel.py (modified) (1 diff)
• fitting/basepage.py (modified) (1 diff)
• fitting/report_dialog.py (modified) (1 diff)
• invariant/invariant_panel.py (modified) (1 diff)
• invariant/report_dialog.py (modified) (1 diff)
• pr/explore_dialog.py (modified) (3 diffs)
• pr/inversion_panel.py (modified) (1 diff)
• simulation/SimCanvas.py (modified) (35 diffs)
• fitting/media/fitting.rst (modified) (2 diffs)
• fitting/media/fitting_help.rst (modified) (5 diffs)
• fitting/media/p_and_s_buttons.png (added)
• fitting/media/p_and_s_buttons_parameters.png (added)
• fitting/media/p_and_s_sum_model.png (added)
• fitting/media/p_and_s_sum_model_parameters.png (added)

src/sas/sasgui/perspectives/calculator/data_editor.py

@@ -19 +19 @@
 _QMAX_DEFAULT = 0.13
 _NPTS_DEFAULT = 50
-#Control panel width 
+#Control panel width
 if sys.platform.count("darwin") == 0:
     PANEL_WIDTH = 500
@@ -196 +196 @@
         summary = 'No data info available...'
         self.data_summary.SetValue(summary)
-        #self.summary_sizer.Add(self.data_summary, 1, wx.EXPAND|wx.ALL, 10)  
+        #self.summary_sizer.Add(self.data_summary, 1, wx.EXPAND|wx.ALL, 10)
 
     def _layout_button(self):
@@ -579 +579 @@
         wildcard = "CanSAS 1D files(*.xml)|*.xml"
         dlg = wx.FileDialog(self, "Choose a file",
-                            self._default_save_location, "", wildcard , wx.SAVE)
+                            self._default_save_location, "", wildcard ,
+                            wx.FD_SAVE)
 
         for data in self._data:

src/sas/sasgui/perspectives/calculator/data_operator.py

@@ -866 +866 @@
         except:
             # toolbar event
-            pos_x, pos_y = self.toolbar.GetPositionTuple()
+            pos_x, pos_y = self.toolbar.GetPosition()
             pos = (pos_x, pos_y + 5)
         self.PopupMenu(slicerpop, pos)

src/sas/sasgui/perspectives/calculator/gen_scatter_panel.py

@@ -43 +43 @@
 
 _BOX_WIDTH = 76
-#Slit length panel size 
+#Slit length panel size
 if sys.platform.count("win32") > 0:
     PANEL_TOP = 0
@@ -133 +133 @@
         #kwds['style'] = wx.SUNKEN_BORDER
         PanelBase.__init__(self)
-        #Font size 
+        #Font size
         self.SetWindowVariant(variant=FONT_VARIANT)
         self.SetupScrolling()
-        #thread to read data 
+        #thread to read data
         self.reader = None
         self.ext = None
@@ -218 +218 @@
         iy = 0
         param_title = wx.StaticText(self, -1, 'Parameter')
-        sizer.Add(param_title, (iy, ix), (1, 1), \
-                            wx.EXPAND | wx.ADJUST_MINSIZE, 0)
+        sizer.Add(param_title, (iy, ix), (1, 1),
+                  wx.EXPAND | wx.ADJUST_MINSIZE, 0)
         ix += 1
         value_title = wx.StaticText(self, -1, 'Value')
-        sizer.Add(value_title, (iy, ix), (1, 1), \
-                            wx.EXPAND | wx.ADJUST_MINSIZE, 0)
+        sizer.Add(value_title, (iy, ix), (1, 1),
+                  wx.EXPAND | wx.ADJUST_MINSIZE, 0)
         ix += 1
         unit_title = wx.StaticText(self, -1, 'Unit')
-        sizer.Add(unit_title, (iy, ix), (1, 1), \
-                            wx.EXPAND | wx.ADJUST_MINSIZE, 0)
+        sizer.Add(unit_title, (iy, ix), (1, 1),
+                  wx.EXPAND | wx.ADJUST_MINSIZE, 0)
         for param in sorted(params.keys()):
             iy += 1
             ix = 0
             p_name = wx.StaticText(self, -1, param)
-            sizer.Add(p_name, (iy, ix), (1, 1), \
-                            wx.EXPAND | wx.ADJUST_MINSIZE, 0)
+            sizer.Add(p_name, (iy, ix), (1, 1),
+                      wx.EXPAND | wx.ADJUST_MINSIZE, 0)
             ## add parameter value
             ix += 1
@@ -239 +239 @@
             ctl = InputTextCtrl(self, -1, size=(_BOX_WIDTH * 2, 20),
                                 style=wx.TE_PROCESS_ENTER)
-            #ctl.SetToolTipString(\
+            #ctl.SetToolTipString(
             #            "Hit 'Enter' after typing to update the plot.")
             ctl.SetValue(format_number(value, True))
@@ -246 +246 @@
             ix += 1
             unit = wx.StaticText(self, -1, details[param][0])
-            sizer.Add(unit, (iy, ix), (1, 1), \
-                            wx.EXPAND | wx.ADJUST_MINSIZE, 0)
+            sizer.Add(unit, (iy, ix), (1, 1),
+                      wx.EXPAND | wx.ADJUST_MINSIZE, 0)
             self.parameters.append([p_name, ctl, unit])
 
@@ -340 +340 @@
         iy = 0
         name = wx.StaticText(self, -1, 'No. of Qx (Qy) bins: ')
-        sizer.Add(name, (iy, ix), (1, 1), \
-                        wx.EXPAND | wx.ADJUST_MINSIZE, 0)
+        sizer.Add(name, (iy, ix), (1, 1),
+                  wx.EXPAND | wx.ADJUST_MINSIZE, 0)
         ## add parameter value
         ix += 1
         self.npt_ctl = InputTextCtrl(self, -1, size=(_BOX_WIDTH * 1.5, 20),
-                            style=wx.TE_PROCESS_ENTER)
+                                     style=wx.TE_PROCESS_ENTER)
         self.npt_ctl.Bind(wx.EVT_TEXT, self._onparamEnter)
         self.npt_ctl.SetValue(format_number(self.npts_x, True))
@@ -352 +352 @@
         ix += 1
         unit = wx.StaticText(self, -1, '')
-        sizer.Add(unit, (iy, ix), (1, 1), \
-                        wx.EXPAND | wx.ADJUST_MINSIZE, 0)
+        sizer.Add(unit, (iy, ix), (1, 1),
+                  wx.EXPAND | wx.ADJUST_MINSIZE, 0)
         iy += 1
         ix = 0
         name = wx.StaticText(self, -1, 'Qx (Qy) Max: ')
-        sizer.Add(name, (iy, ix), (1, 1), \
-                        wx.EXPAND | wx.ADJUST_MINSIZE, 0)
+        sizer.Add(name, (iy, ix), (1, 1),
+                  wx.EXPAND | wx.ADJUST_MINSIZE, 0)
         ## add parameter value
         ix += 1
@@ -369 +369 @@
         ix += 1
         unit = wx.StaticText(self, -1, '[1/A]')
-        sizer.Add(unit, (iy, ix), (1, 1), \
-                        wx.EXPAND | wx.ADJUST_MINSIZE, 0)
+        sizer.Add(unit, (iy, ix), (1, 1),
+                  wx.EXPAND | wx.ADJUST_MINSIZE, 0)
         self.qrange_sizer.Add(sizer, 0, wx.LEFT, 10)
 
@@ -684 +684 @@
         self.sld_data = self.parent.get_sld_from_omf()
         output = self.sld_data
-        #frame_size = wx.Size(470, 470)    
+        #frame_size = wx.Size(470, 470)
         self.plot_frame = PlotFrame(self, -1, 'testView')
         frame = self.plot_frame
@@ -703 +703 @@
         panel.dimension = 3
         graph_title = self._sld_plot_helper(ax, output, has_arrow)
-        # Use y, z axes (in mpl 3d) as z, y axes 
+        # Use y, z axes (in mpl 3d) as z, y axes
         # that consistent with our SAS detector coords.
-        ax.set_xlabel('x ($\A%s$)' % output.pos_unit)
-        ax.set_ylabel('z ($\A%s$)' % output.pos_unit)
-        ax.set_zlabel('y ($\A%s$)' % output.pos_unit)
+        # Format Angstrom units (A) as latex $\AA$
+        units = output.pos_unit if output.pos_unit != "A" else r"$\AA$"
+        ax.set_xlabel('x (%s)' % units)
+        ax.set_ylabel('z (%s)' % units)
+        ax.set_zlabel('y (%s)' % units)
         panel.subplot.figure.subplots_adjust(left=0.05, right=0.95,
                                              bottom=0.05, top=0.96)
@@ -741 +743 @@
             marker = 'o'
             m_size = 3.5
-        sld_tot = (np.fabs(sld_mx) + np.fabs(sld_my) + \
-                   np.fabs(sld_mz) + np.fabs(output.sld_n))
+        sld_tot = (np.fabs(sld_mx) + np.fabs(sld_my)
+                   + np.fabs(sld_mz) + np.fabs(output.sld_n))
         is_nonzero = sld_tot > 0.0
         is_zero = sld_tot == 0.0
@@ -766 +768 @@
                         pos_y[chosen_color], marker, c=color, alpha=0.5,
                         markeredgecolor=color, markersize=m_size, label=key)
-        # III. Plot All others        
+        # III. Plot All others
         if np.any(other_color):
             a_name = ''
@@ -1028 +1030 @@
         self.data = Data2D()
         qmax = self.qmax_x #/ np.sqrt(2)
-        self.data.xaxis('\\rm{Q_{x}}', '\AA^{-1}')
-        self.data.yaxis('\\rm{Q_{y}}', '\AA^{-1}')
+        self.data.xaxis(r'\rm{Q_{x}}', r'\AA^{-1}')
+        self.data.yaxis(r'\rm{Q_{y}}', r'\AA^{-1}')
         self.data.is_data = False
         self.data.id = str(self.uid) + " GenData"
@@ -1120 +1122 @@
         new_plot.dx = data.dx
         new_plot.dy = data.dy
-        new_plot.xaxis('\\rm{Q_{x}}', '\AA^{-1}')
-        new_plot.yaxis('\\rm{Intensity}', 'cm^{-1}')
+        new_plot.xaxis(r'\rm{Q_{x}}', r'\AA^{-1}')
+        new_plot.yaxis(r'\rm{Intensity}', 'cm^{-1}')
         new_plot.is_data = False
         new_plot.id = str(self.uid) + " GenData1D"
@@ -1127 +1129 @@
         new_plot.name = model.name + '1d'
         new_plot.title = "Generic model1D "
-        new_plot.id = str(page_id) + ': ' + self.file_name \
-                        + ' #%s' % str(self.graph_num) + "_1D"
-        new_plot.group_id = str(page_id) + " Model1D" + \
-                             ' #%s' % str(self.graph_num) + "_1D"
+        new_plot.id = (str(page_id) + ': ' + self.file_name
+                       + ' #%s' % str(self.graph_num) + "_1D")
+        new_plot.group_id = (str(page_id) + " Model1D"
+                             + ' #%s' % str(self.graph_num) + "_1D")
         new_plot.is_data = False
 
@@ -1175 +1177 @@
         new_plot.name = model.name + '2d'
         new_plot.title = "Generic model 2D "
-        new_plot.id = str(page_id) + ': ' + self.file_name \
-                        + ' #%s' % str(self.graph_num) + "_2D"
-        new_plot.group_id = str(page_id) + " Model2D" \
-                        + ' #%s' % str(self.graph_num) + "_2D"
+        new_plot.id = (str(page_id) + ': ' + self.file_name
+                       + ' #%s' % str(self.graph_num) + "_2D")
+        new_plot.group_id = (str(page_id) + " Model2D"
+                             + ' #%s' % str(self.graph_num) + "_2D")
         new_plot.detector = data.detector
         new_plot.source = data.source
@@ -1243 +1245 @@
                                *args, **kwds)
         PanelBase.__init__(self)
-        #Font size 
+        #Font size
         self.SetWindowVariant(variant=FONT_VARIANT)
         self.SetupScrolling()
@@ -1446 +1448 @@
             ix = 0
             name = wx.StaticText(self, -1, key)
-            sizer.Add(name, (iy, ix), (1, 1), \
-                            wx.EXPAND | wx.ADJUST_MINSIZE, 0)
+            sizer.Add(name, (iy, ix), (1, 1),
+                      wx.EXPAND | wx.ADJUST_MINSIZE, 0)
             ## add parameter value
             ix += 1
@@ -1459 +1461 @@
             s_unit = '[' + omfdata.sld_unit + ']'
             unit = wx.StaticText(self, -1, s_unit)
-            sizer.Add(unit, (iy, ix), (1, 1), \
-                            wx.EXPAND | wx.ADJUST_MINSIZE, 0)
+            sizer.Add(unit, (iy, ix), (1, 1),
+                      wx.EXPAND | wx.ADJUST_MINSIZE, 0)
             self.slds.append([key, ctl, unit])
         self.sld_sizer.Add(sizer, 0, wx.LEFT, 10)
@@ -1481 +1483 @@
             ix = 0
             name = wx.StaticText(self, -1, key)
-            sizer.Add(name, (iy, ix), (1, 1), \
-                            wx.EXPAND | wx.ADJUST_MINSIZE, 0)
+            sizer.Add(name, (iy, ix), (1, 1),
+                      wx.EXPAND | wx.ADJUST_MINSIZE, 0)
             ## add parameter value
             ix += 1
@@ -1494 +1496 @@
             ix += 1
             unit = wx.StaticText(self, -1, '')
-            sizer.Add(unit, (iy, ix), (1, 1), \
-                            wx.EXPAND | wx.ADJUST_MINSIZE, 0)
+            sizer.Add(unit, (iy, ix), (1, 1),
+                      wx.EXPAND | wx.ADJUST_MINSIZE, 0)
             self.nodes.append([key, ctl, unit])
         self.node_sizer.Add(sizer, 0, wx.LEFT, 10)
@@ -1516 +1518 @@
             ix = 0
             name = wx.StaticText(self, -1, key)
-            sizer.Add(name, (iy, ix), (1, 1), \
-                            wx.EXPAND | wx.ADJUST_MINSIZE, 0)
+            sizer.Add(name, (iy, ix), (1, 1),
+                      wx.EXPAND | wx.ADJUST_MINSIZE, 0)
             ## add parameter value
             ix += 1
@@ -1530 +1532 @@
             p_unit = '[' + omfdata.pos_unit + ']'
             unit = wx.StaticText(self, -1, p_unit)
-            sizer.Add(unit, (iy, ix), (1, 1), \
-                            wx.EXPAND | wx.ADJUST_MINSIZE, 0)
+            sizer.Add(unit, (iy, ix), (1, 1),
+                      wx.EXPAND | wx.ADJUST_MINSIZE, 0)
             self.stepsize.append([key, ctl, unit])
         self.step_sizer.Add(sizer, 0, wx.LEFT, 10)
@@ -1626 +1628 @@
             for ctr_list in self.slds:
                 ctr_list[1].Enable(False)
-                #break   
+                #break
             return
 
@@ -1637 +1639 @@
                     max_val = np.max(sld_list[key])
                     mean_val = np.mean(sld_list[key])
-                    enable = (min_val == max_val) and \
-                             sld_data.pix_type == 'pixel'
+                    enable = ((min_val == max_val)
+                              and sld_data.pix_type == 'pixel')
                     ctr_list[1].SetValue(format_number(mean_val, True))
                     ctr_list[1].Enable(enable)
@@ -1669 +1671 @@
                             location, "sld_file",
                              extension,
-                             wx.SAVE)
+                             wx.FD_SAVE)
         if dlg.ShowModal() == wx.ID_OK:
             path = dlg.GetPath()

src/sas/sasgui/perspectives/calculator/image_viewer.py

@@ -62 +62 @@
                 # Any other formats (tiff, jpeg, etc) are passed
                 # to PIL which seems to have a problem in version
-                # 1.1.7 that causes a close error which shows up in 
+                # 1.1.7 that causes a close error which shows up in
                 # the log file.  This does not seem to have any adverse
                 # effects.  PDB   --- September 17, 2017.
@@ -383 +383 @@
                 print(err_msg)
 
-        self.OnClose(event)
+        self.EndModal(wx.ID_OK)
 
     def convert_image(self, rgb, xmin, xmax, ymin, ymax, zscale):
@@ -417 +417 @@
         output.ymin = ymin
         output.ymax = ymax
-        output.xaxis('\\rm{Q_{x}}', '\AA^{-1}')
-        output.yaxis('\\rm{Q_{y}}', '\AA^{-1}')
+        output.xaxis(r'\rm{Q_{x}}', r'\AA^{-1}')
+        output.yaxis(r'\rm{Q_{y}}', r'\AA^{-1}')
         # Store loading process information
         output.meta_data['loader'] = self.title.split('.')[-1] + "Reader"
@@ -451 +451 @@
         # clear event
         event.Skip()
-        self.Destroy()
+        self.EndModal(wx.ID_CANCEL)
+        #self.Destroy()
 
 if __name__ == "__main__":

src/sas/sasgui/perspectives/corfunc/corfunc_panel.py

@@ -337 +337 @@
         dlg = wx.FileDialog(self, "Choose a file",
                             default_save_location, \
-                            self.window_caption, "*.crf", wx.SAVE)
+                            self.window_caption, "*.crf", wx.FD_SAVE)
         if dlg.ShowModal() == wx.ID_OK:
             path = dlg.GetPath()

src/sas/sasgui/perspectives/fitting/basepage.py

@@ -676 +676 @@
                         self._manager.parent._default_save_location
         dlg = wx.FileDialog(self, "Choose a file", self._default_save_location,
-                            self.window_caption, "*.fitv", wx.SAVE)
+                            self.window_caption, "*.fitv", wx.FD_SAVE)
 
         if dlg.ShowModal() == wx.ID_OK:

src/sas/sasgui/perspectives/fitting/report_dialog.py

@@ -49 +49 @@
         dlg = wx.FileDialog(self, "Choose a file",
                             wildcard=self.wild_card,
-                            style=wx.SAVE | wx.OVERWRITE_PROMPT | wx.CHANGE_DIR)
+                            style=wx.FD_SAVE | wx.OVERWRITE_PROMPT | wx.CHANGE_DIR)
         dlg.SetFilterIndex(0)  # Set .html files to be default
 

src/sas/sasgui/perspectives/invariant/invariant_panel.py

@@ -1255 +1255 @@
         dlg = wx.FileDialog(self, "Choose a file",
                             self._default_save_location, \
-                            self.window_caption, "*.inv", wx.SAVE)
+                            self.window_caption, "*.inv", wx.FD_SAVE)
         if dlg.ShowModal() == wx.ID_OK:
             path = dlg.GetPath()

src/sas/sasgui/perspectives/invariant/report_dialog.py

@@ -52 +52 @@
         dlg = wx.FileDialog(self, "Choose a file",
                             wildcard=self.wild_card,
-                            style=wx.SAVE | wx.OVERWRITE_PROMPT | wx.CHANGE_DIR)
+                            style=wx.FD_SAVE | wx.OVERWRITE_PROMPT | wx.CHANGE_DIR)
         dlg.SetFilterIndex(0)  # Set .html files to be default
 

src/sas/sasgui/perspectives/pr/explore_dialog.py

@@ -50 +50 @@
     window_caption = "D Explorer"
 
-    def __init__(self, d_min, d_max, parent, id= -1, color=None, \
+    def __init__(self, d_min, d_max, parent, id= -1, color=None,
                  dpi=None, style=wx.NO_FULL_REPAINT_ON_RESIZE, **kwargs):
         """
@@ -77 +77 @@
         self.plot.symbol = GUIFRAME_ID.CURVE_SYMBOL_NUM
 
-        # Graph        
+        # Graph
         self.graph = Graph()
-        self.graph.xaxis("\\rm{D_{max}}", 'A')
-        self.graph.yaxis("\\rm{%s}" % DEFAULT_OUTPUT, "")
+        self.graph.xaxis(r"\rm{D_{max}}", 'A')
+        self.graph.yaxis(r"\rm{%s}" % DEFAULT_OUTPUT, "")
         self.graph.add(self.plot)
         self.graph.render(self)
@@ -133 +133 @@
         # Dictionary of outputs
         self.outputs = {}
-        self.outputs['Chi2/dof'] = ["\chi^2/dof", "a.u.", self.chi2]
+        self.outputs['Chi2/dof'] = [r"\chi^2/dof", "a.u.", self.chi2]
         self.outputs['Oscillation parameter'] = ["Osc", "a.u.", self.osc]
         self.outputs['Positive fraction'] = ["P^+", "a.u.", self.pos]
-        self.outputs['1-sigma positive fraction'] = ["P^+_{1\ \sigma}",
+        self.outputs['1-sigma positive fraction'] = [r"P^+_{1\ \sigma}",
                                                      "a.u.", self.pos_err]
         self.outputs['Rg'] = ["R_g", "A", self.rg]

src/sas/sasgui/perspectives/pr/inversion_panel.py

@@ -282 +282 @@
         dlg = wx.FileDialog(self, "Choose a file",
                             self._default_save_location,
-                            self.window_caption, "*.prv", wx.SAVE)
+                            self.window_caption, "*.prv", wx.FD_SAVE)
         if dlg.ShowModal() == wx.ID_OK:
             path = dlg.GetPath()

src/sas/sasgui/perspectives/simulation/SimCanvas.py

@@ -2 +2 @@
 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. 
+project funded by the US National Science Foundation.
 
 See the license text in license.txt
@@ -32 +32 @@
 except ImportError:
     haveOpenGL = False
-    
+
 # Color set
-DEFAULT_COLOR = [1.0, 1.0, 0.0, .2]    
+DEFAULT_COLOR = [1.0, 1.0, 0.0, .2]
 COLOR_RED     = [1.0, 0.0, 0.0, .2]
 COLOR_GREEN   = [0.0, 1.0, 0.0, .2]
@@ -48 +48 @@
 class SimPanel(wx.Panel):
     """
-        3D viewer to support real-space simulation. 
+        3D viewer to support real-space simulation.
     """
     window_name = "3dview"
     window_caption = "3D viewer"
-    
+
     def __init__(self, parent, id = -1, plots = None, standalone=False, **kwargs):
         wx.Panel.__init__(self, parent, id = id, **kwargs)
         self.parent = parent
-    
+
         #Add a sizer
         mainSizer = wx.BoxSizer(wx.VERTICAL)
         sliderSizer = wx.BoxSizer(wx.HORIZONTAL)
-    
-        self.canvas    = CanvasBase(self) 
+
+        self.canvas    = CanvasBase(self)
         self.canvas.SetMinSize((200,2100))
 
@@ -72 +72 @@
         self.SetSizer(mainSizer)
         self.Bind(wx.EVT_CONTEXT_MENU, self._on_context_menu)
-        
- 
+
+
     def _on_context_menu(self, event):
         """
@@ -83 +83 @@
         slicerpop.Append(id, '&Reset 3D View')
         wx.EVT_MENU(self, id, self.canvas.resetView)
-       
+
         pos = event.GetPosition()
         pos = self.ScreenToClient(pos)
-        self.PopupMenu(slicerpop, pos)        
-    
+        self.PopupMenu(slicerpop, pos)
+
 class CanvasBase(glcanvas.GLCanvas):
     """
@@ -94 +94 @@
     window_name = "Simulation"
     window_caption = "Simulation"
-    
+
     def __init__(self, parent):
         glcanvas.GLCanvas.__init__(self, parent, -1)
@@ -113 +113 @@
         self.Bind(wx.EVT_MOTION, self.OnMouseMotion)
         self.Bind(wx.EVT_MOUSEWHEEL, self._onMouseWheel)
-        
+
         self.initialized = False
         self.shapes = []
         self.parent = parent
-        
+
         # Reference vectors
         self.x_vec = [1,0,0]
         self.y_vec = [0,1,0]
-        
+
         self.mouse_down = False
         self.scale = 1.0
         self.zoom  = 1.0
         self.translation = [0,0,0]
-        
+
         # Bind to Edit events
         self.parent.Bind(ShapeParameters.EVT_EDIT_SHAPE, self._onEditShape)
-        
+
     def resetView(self, evt=None):
         """
@@ -140 +140 @@
         glLoadIdentity()
         self.Refresh()
-                
+
     def _onEditShape(self, evt):
         evt.Skip()
@@ -158 +158 @@
         event.Skip()
 
-    def OnPaint(self, event):     
+    def OnPaint(self, event):
         size = self.GetClientSize()
         side = size.width
         if size.height<size.width:
             side = size.height
-        
+
         if self.GetContext():
             glViewport(0, 0, side, side)
             self.SetMinSize((side,side))
-            
+
         dc = wx.PaintDC(self)
         self.SetCurrent()
@@ -174 +174 @@
             self.init = True
         self.OnDraw()
-        event.Skip()        
-        
+        event.Skip()
+
     def _onMouseWheel(self, evt):
         # Initialize mouse position so we don't have unwanted rotation
         self.x, self.y = self.lastx, self.lasty = evt.GetPosition()
         self.tr_x, self.tr_y = self.tr_lastx, self.tr_lasty = evt.GetPosition()
-        
+
         scale = 1.15
         if evt.GetWheelRotation()<0:
             scale = 1.0/scale
-             
-        self.zoom *= scale             
-             
+
+        self.zoom *= scale
+
         glScale(scale, scale, scale)
         self.Refresh(False)
-        
+
     def OnMouseDown(self, evt):
         self.SetFocus()
@@ -214 +214 @@
         slicerpop.Append(id, '&Reset 3D View')
         wx.EVT_MENU(self, id, self.resetView)
-       
+
         pos = event.GetPosition()
         #pos = self.ScreenToClient(pos)
-        self.PopupMenu(slicerpop, pos)        
+        self.PopupMenu(slicerpop, pos)
 
     def OnMouseMotion(self, evt):
@@ -223 +223 @@
             self.tr_lastx, self.tr_lasty = self.tr_x, self.tr_y
             x, y = evt.GetPosition()
-            
+
             # Min distance to do anything
             if math.fabs(self.lastx-x)>10 or math.fabs(self.lasty-y)>10:
-                
+
                 self.lastx, self.lasty = self.x, self.y
-        
-                
+
+
                 if math.fabs(self.lastx-x)>math.fabs(self.lasty-y):
                     self.x = x
                 else:
                     self.y = y
-                
+
                 #self.x, self.y = evt.GetPosition()
                 self.Refresh(False)
-                
+
         elif evt.Dragging() and evt.RightIsDown():
             self.lastx, self.lasty = self.x, self.y
@@ -243 +243 @@
             self.tr_x, self.tr_y = evt.GetPosition()
             self.Refresh(False)
-            
-    def InitGL( self ):      
+
+    def InitGL( self ):
         glutInitDisplayMode (GLUT_DOUBLE | GLUT_RGBA)
         #glShadeModel(GL_FLAT);
-        
+
         glMatrixMode(GL_PROJECTION)
-        
+
         glLight(GL_LIGHT0, GL_AMBIENT, [.2, .2, .2, 0])
-        
+
         # Object color
         #glLight(GL_LIGHT0, GL_DIFFUSE, COLOR_BLUE)
-        
+
         glLight(GL_LIGHT0, GL_POSITION, [1.0, 1.0, -1.0, 0.0])
-        
-        
+
+
         glLightModelfv(GL_LIGHT_MODEL_AMBIENT, [1, 1, 1, 0])
         glEnable(GL_LIGHTING)
@@ -263 +263 @@
         glEnable(GL_BLEND)
         glBlendFunc (GL_SRC_ALPHA, GL_ONE_MINUS_SRC_ALPHA);
-        
+
         glEnable ( GL_ALPHA_TEST ) ;
         glAlphaFunc ( GL_GREATER, 0 ) ;
         glPixelStorei(GL_PACK_ALIGNMENT, 1)
         glPixelStorei(GL_UNPACK_ALIGNMENT, 1)
-        
+
         glEnable(GL_NORMALIZE)
         glDepthFunc(GL_LESS)
@@ -276 +276 @@
         #glClear (GL_COLOR_BUFFER_BIT);
         glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT)
-        
-        
+
+
         gluPerspective(0, 1.0, 0.1, 60.0);
 
@@ -296 +296 @@
         glClear(GL_COLOR_BUFFER_BIT | GL_DEPTH_BUFFER_BIT)
         # use a fresh transformation matrix
-        
+
         # get the max object size to re-scale
         max_size = 1.0
@@ -305 +305 @@
             if l>max_size:
                 max_size = l
-        
+
         max_size *= 1.05
         scale = self.scale/max_size
         glScale(scale, scale, scale)
         self.scale = max_size
-        
+
         self.drawAxes()
-        
+
         if self.mouse_down:
             if math.fabs((self.x - self.lastx))>math.fabs((self.y - self.lasty)):
-                angle = 10.0*(self.x - self.lastx) / math.fabs(self.x - self.lastx) 
+                angle = 10.0*(self.x - self.lastx) / math.fabs(self.x - self.lastx)
                 glRotate(angle, self.y_vec[0], self.y_vec[1], self.y_vec[2]);
                 self._rot_y(angle)
             elif math.fabs(self.y - self.lasty)>0:
-                angle = 10.0*(self.y - self.lasty) / math.fabs(self.y - self.lasty) 
+                angle = 10.0*(self.y - self.lasty) / math.fabs(self.y - self.lasty)
                 glRotate(angle, self.x_vec[0], self.x_vec[1], self.x_vec[2]);
                 self._rot_x(angle)
@@ -325 +325 @@
             self.lasty = self.y
             self.lastx = self.x
-        
-            w,h = self.GetVirtualSizeTuple()
-        
+
+            w, h = self.GetVirtualSize()
+
             # Translate in the x-y plane
             vx = self.x_vec[0] * 2.0*float(self.tr_x - self.tr_lastx)/w \
@@ -335 +335 @@
             vz = self.x_vec[2] * 2.0*float(self.tr_x - self.tr_lastx)/w \
                + self.y_vec[2] * 2.0*float(self.tr_lasty - self.tr_y)/h
-            
-            glTranslate(self.scale*vx/self.zoom, self.scale*vy/self.zoom, self.scale*vz/self.zoom)    
-                
+
+            glTranslate(self.scale*vx/self.zoom, self.scale*vy/self.zoom, self.scale*vz/self.zoom)
+
         # push into visible buffer
         self.SwapBuffers()
-        
+
     def _matrix_mult(self, v, axis, angle):
         c = math.cos(angle)
-        s = math.sin(angle) 
+        s = math.sin(angle)
         x = axis[0]
         y = axis[1]
@@ -351 +351 @@
         vz = v[0]*(x*z*(1-c)-y*s) + v[1]*(y*z*(1-c)+x*s) + v[2]*(z*z*(1-c)+c)
         return [vx, vy, vz]
-    
+
     def _rot_y(self, theta):
         """
             Rotate the view by theta around the y-axis
         """
-        angle = theta/180.0*math.pi 
+        angle = theta/180.0*math.pi
         axis = self.y_vec
         self.x_vec = self._matrix_mult(self.x_vec, self.y_vec, -angle)
-        
+
     def _rot_x(self, theta):
         """
@@ -366 +366 @@
         angle = theta/180.0*math.pi
         self.y_vec = self._matrix_mult(self.y_vec, self.x_vec, -angle)
-        
-        
+
+
     def addShape(self, shape, name=None):
         """
@@ -403 +403 @@
 
     def drawAxes(self):
-        """ 
+        """
             Draw 3D axes
         """
         pos = self.scale * 0.7
-       
+
         # Z-axis is red
-        zaxis= Arrow(x=pos, y=-pos, z=0, r_cyl=self.scale*0.005, r_cone=self.scale*0.01, 
+        zaxis= Arrow(x=pos, y=-pos, z=0, r_cyl=self.scale*0.005, r_cone=self.scale*0.01,
                      l_cyl=self.scale*0.1, l_cone=self.scale*0.05)
         zaxis.color = COLOR_RED
         zaxis.draw()
-        
+
         # Y-axis is yellow
-        yaxis= Arrow(x=pos, y=-pos, z=0, r_cyl=self.scale*0.005, r_cone=self.scale*0.01, 
+        yaxis= Arrow(x=pos, y=-pos, z=0, r_cyl=self.scale*0.005, r_cone=self.scale*0.01,
                      l_cyl=self.scale*0.1, l_cone=self.scale*0.05)
         yaxis.color = COLOR_YELLOW
         yaxis.rotate(-90,0,0)
         yaxis.draw()
-        
+
         # X-axis is green
-        xaxis= Arrow(x=pos, y=-pos, z=0, r_cyl=self.scale*0.005, r_cone=self.scale*0.01, 
+        xaxis= Arrow(x=pos, y=-pos, z=0, r_cyl=self.scale*0.005, r_cone=self.scale*0.01,
                      l_cyl=self.scale*0.1, l_cone=self.scale*0.05)
         xaxis.color = COLOR_GREEN
         xaxis.rotate(0,-90,0)
         xaxis.draw()
-        
+
         glLight(GL_LIGHT0, GL_DIFFUSE, DEFAULT_COLOR)
 
@@ -445 +445 @@
         self.theta_y = 0
         self.theta_z = 0
-        
+
         # Params
         self.params = {}
@@ -453 +453 @@
         self.details['contrast'] = 'A-2'
         self.details['order']    = ' '
-        
+
         self.highlighted = False
         self.color = DEFAULT_COLOR
-    
+
     def get_volume(self):
         return 0
-    
+
     def get_length(self):
         return 1.0
-    
+
     def highlight(self, value=False):
         self.highlighted = value
-        
+
     def rotate(self, alpha, beta, gamma):
-        """ 
+        """
             Set the rotation angles of the shape
             @param alpha: angle around the x-axis [degrees]
@@ -476 +476 @@
         self.theta_y = beta
         self.theta_z = gamma
-        
+
     def _rotate(self):
         """
             Perform the OpenGL rotation
-            
+
             Note that the rotation order is reversed.
             We do Y, X, Z do be compatible with simulation...
         """
-        
+
         glRotated(self.theta_z, 0, 0, 1)
         glRotated(self.theta_x, 1, 0, 0)
         glRotated(self.theta_y, 0, 1, 0)
-        
+
     def _pre_draw(self):
         if self.highlighted:
@@ -506 +506 @@
         self.l_cyl = l_cyl
         self.l_cone = l_cone
-           
+
     def draw(self):
         self._pre_draw()
         glPushMatrix()
         glTranslate(self.x, self.y, self.z)
-        
+
         # Perform rotation
         glRotate(self.theta_x, 1, 0, 0)
@@ -520 +520 @@
         qobj = gluNewQuadric();
         gluCylinder(qobj, self.r_cyl, self.r_cyl, self.l_cyl, 15, 5);
-                
+
         glTranslate(0, 0, self.z+self.l_cyl)
-        
+
         # Draw cone of the arrow
         glutSolidCone(self.r_cone, self.l_cone, 30, 5)
-        
+
         # Translate back to original position
         glTranslate(-self.x, -self.y, -self.z)
@@ -538 +538 @@
         self.radius = radius
         self.height = height
-        
+
     def draw(self):
         glPushMatrix()
@@ -556 +556 @@
         self.params['radius'] = radius
         self.details['radius'] = 'A'
-        
+
     def get_volume(self):
         return 4.0/3.0*math.pi*self.params['radius']*self.params['radius']*self.params['radius']
-        
+
     def get_length(self):
         return 2.0*self.params['radius']
-    
+
     def draw(self):
         self._pre_draw()
@@ -584 +584 @@
     """
         Cylinder shape, by default the cylinder is oriented along
-        the z-axis. 
-        
+        the z-axis.
+
         The reference point of the cylinder is the center of the
         bottom circle.
@@ -596 +596 @@
         self.details['radius'] = 'A'
         self.details['length'] = 'A'
-        
+
     def get_volume(self):
         return math.pi*self.params['radius']*self.params['radius']*self.params['length']
-        
+
     def get_length(self):
         if self.params['length']>2.0*self.params['radius']:
@@ -605 +605 @@
         else:
             return 2.0*self.params['radius']
-        
+
     def draw(self):
         self._pre_draw()
         glPushMatrix()
-        
+
         glTranslate(self.x, self.y, self.z)
-        self._rotate() 
+        self._rotate()
         qobj = gluNewQuadric();
         # gluCylinder(qobj, r_base, r_top, L, div around z, div along z)
@@ -619 +619 @@
         glPopMatrix()
         glLight(GL_LIGHT0, GL_DIFFUSE, DEFAULT_COLOR)
-        
+
     def accept(self, visitor):
         return visitor.fromCylinder(self)
-        
+
     def accept_update(self, visitor):
         return visitor.update_cylinder(self)
-        
+
 # Fill the shape list
 SHAPE_LIST.append(dict(name='Sphere',   id=wx.NewId(), cl=Sphere))
 SHAPE_LIST.append(dict(name='Cylinder', id=wx.NewId(), cl=Cylinder))
-        
+
 def getShapes():
     """
@@ -635 +635 @@
     """
     return SHAPE_LIST
-    
+
 def getShapeClass(id):
     """
@@ -647 +647 @@
         return shape[0]['cl']
     return None
-    
+
 def getShapeClassByName(name):
     """

src/sas/sasgui/perspectives/fitting/media/fitting.rst

@@ -17 +17 @@
    Smearing Functions <resolution>
 
+   Fitting Models with Structure Factors <fitting_sq>
+
+   Writing a Plugin Model <plugin>
+
    Polarisation/Magnetic Scattering <magnetism/magnetism>
-   
+
    Oriented Particles <orientation/orientation>
 
@@ -27 +31 @@
    Fitting SESANS Data <sesans/sesans_fitting>
 
-   Writing a Plugin Model <plugin>
-
    Computations with a GPU <gpu_setup>
 

src/sas/sasgui/perspectives/fitting/media/fitting_help.rst

@@ -42 +42 @@
 *  *Ellipsoid* - ellipsoidal shapes (oblate,prolate, core shell, etc)
 *  *Parellelepiped* - as the name implies
-*  *Sphere* - sheroidal shapes (sphere, core multishell, vesicle, etc)
+*  *Sphere* - spheroidal shapes (sphere, core multishell, vesicle, etc)
 *  *Lamellae* - lamellar shapes (lamellar, core shell lamellar, stacked
    lamellar, etc)
@@ -61 +61 @@
 on the *Description* button to the right.
 
+Product Models
+^^^^^^^^^^^^^^
+
+S(Q) models can be combined with many models in the other categories to
+generate what SasView calls "product models". The combination can be done by
+one of two methods, but how they behave is slightly different.
+
+The first, most straightforward, method is simply to use the S(Q) drop-down in
+the FitPage:
+
+.. figure:: p_and_s_buttons.png
+
+This example would then generate a product model with the following parameters:
+
+.. figure:: p_and_s_buttons_parameters.png
+
+The other method is to use the :ref:`Sum|Multi(p1,p2)` tool under Fitting >
+Plugin Model Operations:
+
+.. figure:: p_and_s_sum_model.png
+
+This creates a product model with the following parameters:
+
+.. figure:: p_and_s_sum_model_parameters.png
+
+As can be seen, the second method has produced a product model with an extra
+parameter: *radius_effective*. This is the radial distance determining the
+range of the $S(Q)$ interaction and may, or may not, be the same as the
+*radius*, in this example, depending on the concentration of the system. In
+other systems, *radius_effective* may depend on the particle form (shape).
+
+See :ref:`Product_Models` for more information.
+
 Show 1D/2D
 ^^^^^^^^^^
@@ -119 +152 @@
 
 For a complete list of all the library models available in SasView, see
-the `Model Documentation <../../../index.html>`_ .
+the `Model Documentation <../../../sasgui/perspectives/fitting/models/index.html>`_ .
 
 It is also possible to add your own models.
@@ -217 +250 @@
 a P(Q) model has been selected).
 
+.. _Sum|Multi(p1,p2):
+
 Sum|Multi(p1,p2)
 ^^^^^^^^^^^^^^^^
@@ -338 +373 @@
 These optimisers form the *Bumps* package written by P Kienzle. For more information
 on each optimiser, see the :ref:`Fitting_Documentation`.
+
+.. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ
+
+Fitting Integer Parameters
+--------------------------
+
+Most of the parameters in SasView models will naturally take floating point (decimal) 
+values, but there are some parameters which can only have integer values. Examples 
+include, but are not limited to, the number of shells in a multilayer vesicle, the 
+number of beads in a pearl necklace, the number of arms of a star polymer, and so on.
+Wherever possible/recognised, the integer nature of a parameter is specified in the 
+respective model documentation and/or parameter table, so read the documentation 
+carefully!
+
+Integer parameters must be fitted with care.
+
+Start with your best possible guess for the value of the parameter. And using 
+*a priori* knowledge, fix as many of the other parameters as possible.
+ 
+The SasView optimizers treat integer parameters internally as floating point 
+numbers, but the values presented to the user are truncated or rounded, as 
+appropriate.
+
+In most instances integer parameters will probably be greater than zero. A good 
+policy in such cases is to use a constraint to enforce this.
+
+Because an integer parameter should, by definition, only move in integer steps, 
+problems may be encountered if the optimizer step size is too small. Similarly, 
+be **very careful** about applying polydispersity to integer parameters.
+
+The Levenberg-Marquardt and Quasi-Newton BFGS (and other derivative-based) 
+optimizers are probably best avoided for fitting models with integer parameters.
 
 .. ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ