Changeset 792db7d5 in sasview for park_integration/Fitting.py

Timestamp:

Jul 8, 2008 11:48:38 AM (16 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:

6e0f53a

Parents:

1c94a9f1

Message:

more tests added …most of them are failing because of uncertainty , scipy result and park resuls also little bit different

File:

• park_integration/Fitting.py (modified) (4 diffs)

park_integration/Fitting.py

@@ -1 @@
-#class Fitting
+"""
+    @organization: Class Fit contains ScipyFit and ParkFit methods declaration
+    allows to create instance of type ScipyFit or ParkFit to perform either
+    a park fit or a scipy fit.
+"""
 from sans.guitools.plottables import Data1D
 from Loader import Load
@@ -9 +13 @@
 class Fit:
     """ 
-        Wrap class that allows to select the fitting type 
+        Wrap class that allows to select the fitting type.this class 
+        can be used as follow :
+        
+        from sans.fit.Fitting import Fit
+        fitter= Fit()
+        fitter.fit_engine('scipy') or fitter.fit_engine('park')
+        engine = fitter.returnEngine()
+        engine.set_data(data,Uid)
+        engine.set_param( model,model.name, pars)
+        engine.set_model(model,Uid)
+        
+        chisqr1, out1, cov1=engine.fit(pars,qmin,qmax)
     """  
     def __init__(self):
-        
-        # To initialize a type of Fit
+        """
+            self._engine will contain an instance of ScipyFit or ParkFit
+        """
         self._engine=None
           
@@ -20 +36 @@
             Select the type of Fit 
             @param word: the keyword to select the fit type 
+            @raise: if the user does not enter 'scipy' or 'park',
+             a valueError is rase
         """
         if word=="scipy":
@@ -28 +46 @@
             raise ValueError, "enter the keyword scipy or park"
     def returnEngine(self):
+        """ @return self._engine""" 
         return self._engine
     
     def fit(self,pars, qmin=None, qmax=None):
-        """ Do the fit """
+        """Perform the fit """
       
     def set_model(self,model,Uid):