Changeset 526 for trunk/python

Timestamp:

03/01/05 14:30:06 (20 years ago)

Author:

mar637

Message:

added more help

File:

• trunk/python/asapfitter.py (modified) (10 diffs)

trunk/python/asapfitter.py

@@ -105 +105 @@
         Execute the actual fitting process. All the state has to be set.
         Parameters:
-            none
+            row:    specify the row in the scantable
         Example:
             s = scantable('myscan.asap')
@@ -138 +138 @@
 
     def store_fit(self):
+        """
+        Store the fit parameters in the scantable.
+        """
         if self.fitted and self.data is not None:
             pars = list(self.fitter.getparameters())
@@ -145 +148 @@
 
     def set_parameters(self, params, fixed=None, component=None):
+        """
+        Set the parameters to be fitted.
+        Parameters:
+              params:    a vector of parameters
+              fixed:     a vector of which parameters are to be held fixed
+                         (default is none)
+              component: in case of multiple gaussians, the index of the
+                         component
+             """
         if self.fitfunc is None:
             print "Please specify a fitting function first."
@@ -173 +185 @@
         Set the Parameters of a 'Gaussian' component, set with set_function.
         Parameters:
-            component:           The number of the component (Default is the
-                                 first component.
             peak, centre, fhwm:  The gaussian parameters
             peakfixed,
@@ -182 +192 @@
                                  the fitting process. The default is to keep
                                  all parameters flexible.
+            component:           The number of the component (Default is the
+                                 component 0)
         """
         if self.fitfunc != "gauss":
@@ -197 +209 @@
         """
         Return the fit paramters.
-        
+        Parameters:
+             component:    get the parameters for the specified component
+                           only, default is all components
         """
         if not self.fitted:
@@ -282 +296 @@
     def commit(self):
         """
-        Return a new scan where the fits have been commited.
+        Return a new scan where the fits have been commited (subtracted)
         """
         if not self.fitted:
@@ -292 +306 @@
         scan._setspectrum(self.fitter.getresidual())
 
-    def plot(self, residual=False, components=None, plotparms=False,
-             plotrange=None):
+    def plot(self, residual=False, components=None, plotparms=False):
         """
         Plot the last fit.
@@ -299 +312 @@
             residual:    an optional parameter indicating if the residual
                          should be plotted (default 'False')
+            components:  a list of components to plot, e.g [0,1],
+                         -1 plots the total fit. Default is to only
+                         plot the total fit.
+            plotparms:   Inidicates if the parameter values should be present
+                         on the plot
         """
         if not self.fitted:
@@ -332 +350 @@
             cs = components
             if isinstance(components,int): cs = [components]
-            self._p.text(0.15,0.15,str(self.get_parameters()[2]),size=8)
+            if plotparms:
+                self._p.text(0.15,0.15,str(self.get_parameters()[2]),size=8)
             n = len(self.components)
             self._p.palette(4)