source: sasview/park_integration/Fitting.py @ 958b8ad

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since 958b8ad was 93de635d, checked in by Gervaise Alina <gervyh@…>, 14 years ago

edit ftol parameter default value

  • Property mode set to 100644
File size: 3.2 KB
Line 
1"""
2Class Fit contains ScipyFit and ParkFit methods declaration
3allows to create instance of type ScipyFit or ParkFit to perform either
4a park fit or a scipy fit.
5"""
6
7#from scipy import optimize
8from sans.fit.ScipyFitting import ScipyFit
9from sans.fit.ParkFitting import ParkFit
10
11
12class Fit:
13    """
14    Wrap class that allows to select the fitting type.this class
15    can be used as follow : ::
16   
17        from sans.fit.Fitting import Fit
18        fitter= Fit()
19        fitter.fit_engine('scipy') or fitter.fit_engine('park')
20        engine = fitter.returnEngine()
21        engine.set_data(data,id)
22        engine.set_param( model,model.name, pars)
23        engine.set_model(model,id)
24       
25        chisqr1, out1, cov1=engine.fit(pars,qmin,qmax)
26       
27    """ 
28    def __init__(self, engine='scipy'):
29        """
30        """
31        #self._engine will contain an instance of ScipyFit or ParkFit
32        self._engine = None
33        self.set_engine(engine)
34         
35    def set_engine(self, word):
36        """
37        Select the type of Fit
38       
39        :param word: the keyword to select the fit type
40       
41        :raise: if the user does not enter 'scipy' or 'park',
42             a valueError is raised
43             
44        """
45        if word == "scipy":
46            self._engine = ScipyFit()
47        elif word == "park":
48            self._engine = ParkFit()
49        else:
50            raise ValueError, "enter the keyword scipy or park"
51
52    def fit(self, q=None, handler=None, curr_thread=None, ftol=1.49012e-8):
53        """Perform the fit """
54        return self._engine.fit(q, handler, curr_thread=curr_thread,
55                                ftol=ftol)
56     
57    def set_model(self, model, id, pars=[], constraints=[]):
58        """
59        store a model model to fit at the position id of the fit engine
60        """
61        self._engine.set_model(model, id, pars, constraints)
62   
63    def set_data(self, data, id, smearer=None, qmin=None, qmax=None):
64        """
65        Store data to fit at the psotion id of the fit engine
66       
67        :param data: data to fit
68        :param smearer: smearerobject to smear data
69        :param qmin: the minimum q range to fit
70        :param qmax: the minimum q range to fit
71       
72        """
73        self._engine.set_data(data, id, smearer, qmin, qmax)
74       
75    def get_model(self, id):
76        """ return list of data"""
77        self._engine.get_model(id)
78
79
80    def remove_fit_problem(self, id):
81        """remove fitarrange in id"""
82        self._engine.remove_fit_problem(id)
83       
84    def select_problem_for_fit(self, id, value):
85        """
86        select a couple of model and data at the id position in dictionary
87        and set in self.selected value to value
88       
89        :param value: the value to allow fitting.
90             can only have the value one or zero
91        """
92        self._engine.select_problem_for_fit(id, value)
93       
94    def get_problem_to_fit(self, id):
95        """
96        return the self.selected value of the fit problem of id
97           
98        :param id: the id of the problem
99       
100        """
101        return self._engine.get_problem_to_fit(id)
Note: See TracBrowser for help on using the repository browser.