Changeset 74755ff in sasview for theoryview/perspectives/theory/model_panel.py

Timestamp:

Jun 2, 2010 10:17:18 AM (14 years ago)

Author:

Gervaise Alina <gervyh@…>

Branches:

master, ESS_GUI, ESS_GUI_Docs, ESS_GUI_batch_fitting, ESS_GUI_bumps_abstraction, ESS_GUI_iss1116, ESS_GUI_iss879, ESS_GUI_iss959, ESS_GUI_opencl, ESS_GUI_ordering, ESS_GUI_sync_sascalc, costrafo411, magnetic_scatt, release-4.1.1, release-4.1.2, release-4.2.2, release_4.0.1, ticket-1009, ticket-1094-headless, ticket-1242-2d-resolution, ticket-1243, ticket-1249, ticket885, unittest-saveload

Children:

6c79243

Parents:

a45622a

Message:

working on documentation theory view

File:

• theoryview/perspectives/theory/model_panel.py (modified) (15 diffs)

theoryview/perspectives/theory/model_panel.py

@@ -18 +18 @@
 class ModelPanel(BasicPage):
     """
-        FitPanel class contains fields allowing to display results when
-        fitting  a model and one data
-        @note: For Fit to be performed the user should check at least 
+    FitPanel class contains fields allowing to display results when
+    fitting  a model and one data
+    
+    :note: For Fit to be performed the user should check at least 
         one parameter on fit Panel window.
     """
@@ -32 +33 @@
         BasicPage.__init__(self, parent, page_info , model_list_box)
         """ 
-            Initialization of the Panel
+        Initialization of the Panel
         """
         self._fill_model_sizer( self.sizer1)  
@@ -48 +49 @@
     def _on_display_description(self, event):
         """
-            Show or Hide description
-            @param event: wx.EVT_RADIOBUTTON
+        Show or Hide description
+        
+        :param event: wx.EVT_RADIOBUTTON
+        
         """
         self._on_display_description_helper()
@@ -58 +61 @@
     def _on_display_description_helper(self):
         """
-            Show or Hide description
-            @param event: wx.EVT_RADIOBUTTON
+        Show or Hide description
+        
+        :param event: wx.EVT_RADIOBUTTON
+        
         """
         ## Show description
@@ -79 +84 @@
     def _fill_range_sizer(self):
         """
-            Fill the sizer containing the plotting range
-            add  access to npts
+        Fill the sizer containing the plotting range
+        add  access to npts
+        
         """
         ##The following 3 lines are for Mac. Let JHC know before modifying..
@@ -100 +106 @@
     def _on_select_model(self, event): 
         """
-             call back for model selection
+        call back for model selection
+        
         """    
         self._on_select_model_helper() 
@@ -110 +117 @@
     def _fill_model_sizer(self, sizer):
         """
-            fill sizer containing model info
+        fill sizer containing model info
+        
         """
         ##The following 3 lines are for Mac. Let JHC know before modifying..
@@ -129 +137 @@
     def _set_sizer_dispersion(self, dispersity):
         """
-            draw sizer with gaussian, log or schulz dispersity parameters
+        draw sizer with gaussian, log or schulz dispersity parameters
+        
         """
         self.fittable_param=[]
@@ -308 +317 @@
     def _onModel2D(self, event):
         """
-         call manager to plot model in 2D
+        call manager to plot model in 2D
+        
         """
         # If the 2D display is not currently enabled, plot the model in 2D 
@@ -356 +366 @@
     def reset_page(self, state):
         """
-            reset the state
+        reset the state
+        
         """
         self.reset_page_helper(state)
@@ -363 +374 @@
     def select_model(self, model):
         """
-            Select a new model
-            @param model: model object 
+        Select a new model
+        
+        :param model: model object 
+        
         """
         self.model = model
@@ -390 +403 @@
     def set_model_description(self,description,sizer):
         """
-            fill a sizer with description
-            @param description: of type string
-            @param sizer: wx.BoxSizer()
+        fill a sizer with description
+        
+        :param description: of type string
+        :param sizer: wx.BoxSizer()
+        
         """
     
@@ -442 +457 @@
     def on_button_clicked(self,event):
         """
-        #On 'More details' button
+        On 'More details' button
         """
         from help_panel import  HelpWindow
@@ -459 +474 @@
            wx.PostEvent(self.parent, StatusEvent(status = msg ))
                      
-            
-            
     def set_range(self, qmin_x, qmax_x, npts):
         """
-            Set the range for the plotted models
-            @param qmin: minimum Q
-            @param qmax: maximum Q
-            @param npts: number of Q bins
+        Set the range for the plotted models
+        
+        :param qmin: minimum Q
+        :param qmax: maximum Q
+        :param npts: number of Q bins
+        
         """
         # Set the data members
@@ -472 +487 @@
         self.qmax_x = qmax_x
         self.num_points = npts
-        
         # Set the controls
         #For qmin and qmax, do not use format_number.(If do, qmin and max could be different from what is in the data.)
-       
         self.qmin.SetValue(str(self.qmin_x))
         self.qmax.SetValue(str(self.qmax_x))
         self.npts.SetValue(format_number(self.num_points))
         
-        
     def set_model_param_sizer(self, model):
         """
-            Build the panel from the model content
-            @param model: the model selected in combo box for fitting purpose
+        Build the panel from the model content
+        
+        :param model: the model selected in combo box for fitting purpose
+        
         """
         self.sizer3.Clear(True)