source: sasview/_modules/sas/fit/Fitting.html @ a462c6a

gh-pages
Last change on this file since a462c6a was a462c6a, checked in by ajj, 9 years ago

Rebuild to fix index and modules docs
  • Property mode set to 100644
File size: 19.9 KB
Line 
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
4
5<html xmlns="http://www.w3.org/1999/xhtml">
6  <head>
7    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
8   
9    <title>sas.fit.Fitting &mdash; SasView 3.0.0 documentation</title>
10   
11    <link rel="stylesheet" href="../../../_static/default.css" type="text/css" />
12    <link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
13   
14    <script type="text/javascript">
15      var DOCUMENTATION_OPTIONS = {
16        URL_ROOT:    '../../../',
17        VERSION:     '3.0.0',
18        COLLAPSE_INDEX: false,
19        FILE_SUFFIX: '.html',
20        HAS_SOURCE:  true
21      };
22    </script>
23    <script type="text/javascript" src="../../../_static/jquery.js"></script>
24    <script type="text/javascript" src="../../../_static/underscore.js"></script>
25    <script type="text/javascript" src="../../../_static/doctools.js"></script>
26    <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
27    <link rel="top" title="SasView 3.0.0 documentation" href="../../../index.html" />
28    <link rel="up" title="Module code" href="../../index.html" /> 
29  </head>
30  <body>
31    <div class="related">
32      <h3>Navigation</h3>
33      <ul>
34        <li class="right" style="margin-right: 10px">
35          <a href="../../../genindex.html" title="General Index"
36             accesskey="I">index</a></li>
37        <li class="right" >
38          <a href="../../../py-modindex.html" title="Python Module Index"
39             >modules</a> |</li>
40        <li><a href="../../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
41          <li><a href="../../index.html" accesskey="U">Module code</a> &raquo;</li> 
42      </ul>
43    </div> 
44
45    <div class="document">
46      <div class="documentwrapper">
47        <div class="bodywrapper">
48          <div class="body">
49           
50  <h1>Source code for sas.fit.Fitting</h1><div class="highlight"><pre>
51<span class="sd">&quot;&quot;&quot;</span>
52<span class="sd">Class Fit contains ScipyFit and ParkFit methods declaration</span>
53<span class="sd">allows to create instance of type ScipyFit or ParkFit to perform either</span>
54<span class="sd">a park fit or a scipy fit.</span>
55<span class="sd">&quot;&quot;&quot;</span>
56
57<span class="c">#from scipy import optimize</span>
58<span class="kn">from</span> <span class="nn">sas.fit.ScipyFitting</span> <span class="kn">import</span> <span class="n">ScipyFit</span>
59<span class="kn">from</span> <span class="nn">sas.fit.ParkFitting</span> <span class="kn">import</span> <span class="n">ParkFit</span>
60<span class="kn">from</span> <span class="nn">sas.fit.BumpsFitting</span> <span class="kn">import</span> <span class="n">BumpsFit</span>
61
62<span class="n">ENGINES</span><span class="o">=</span><span class="p">{</span>
63    <span class="s">&#39;scipy&#39;</span><span class="p">:</span> <span class="n">ScipyFit</span><span class="p">,</span>
64    <span class="s">&#39;park&#39;</span><span class="p">:</span> <span class="n">ParkFit</span><span class="p">,</span>
65    <span class="s">&#39;bumps&#39;</span><span class="p">:</span> <span class="n">BumpsFit</span><span class="p">,</span>
66<span class="p">}</span>
67
68<div class="viewcode-block" id="Fit"><a class="viewcode-back" href="../../../dev/api/sas.fit.html#sas.fit.Fitting.Fit">[docs]</a><span class="k">class</span> <span class="nc">Fit</span><span class="p">(</span><span class="nb">object</span><span class="p">):</span>
69    <span class="sd">&quot;&quot;&quot; </span>
70<span class="sd">    Wrap class that allows to select the fitting type.this class </span>
71<span class="sd">    can be used as follow : ::</span>
72<span class="sd">    </span>
73<span class="sd">        from sas.fit.Fitting import Fit</span>
74<span class="sd">        fitter= Fit()</span>
75<span class="sd">        fitter.fit_engine(&#39;scipy&#39;) or fitter.fit_engine(&#39;park&#39;)</span>
76<span class="sd">        engine = fitter.returnEngine()</span>
77<span class="sd">        engine.set_data(data,id)</span>
78<span class="sd">        engine.set_param( model,model.name, pars)</span>
79<span class="sd">        engine.set_model(model,id)</span>
80<span class="sd">        </span>
81<span class="sd">        chisqr1, out1, cov1=engine.fit(pars,qmin,qmax)</span>
82<span class="sd">        </span>
83<span class="sd">    &quot;&quot;&quot;</span> 
84    <span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">engine</span><span class="o">=</span><span class="s">&#39;scipy&#39;</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">):</span>
85        <span class="sd">&quot;&quot;&quot;</span>
86<span class="sd">        &quot;&quot;&quot;</span>
87        <span class="c">#self._engine will contain an instance of ScipyFit or ParkFit</span>
88        <span class="bp">self</span><span class="o">.</span><span class="n">_engine</span> <span class="o">=</span> <span class="bp">None</span>
89        <span class="bp">self</span><span class="o">.</span><span class="n">fitter_id</span> <span class="o">=</span> <span class="bp">None</span>
90        <span class="bp">self</span><span class="o">.</span><span class="n">set_engine</span><span class="p">(</span><span class="n">engine</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">)</span>
91         
92    <span class="k">def</span> <span class="nf">__setattr__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
93        <span class="sd">&quot;&quot;&quot;</span>
94<span class="sd">        set fitter_id and its engine at the same time</span>
95<span class="sd">        &quot;&quot;&quot;</span>
96        <span class="k">if</span> <span class="n">name</span> <span class="o">==</span> <span class="s">&quot;fitter_id&quot;</span><span class="p">:</span>
97            <span class="bp">self</span><span class="o">.</span><span class="n">__dict__</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
98            <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">&quot;_engine&quot;</span><span class="p">)</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">_engine</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
99                <span class="bp">self</span><span class="o">.</span><span class="n">_engine</span><span class="o">.</span><span class="n">fitter_id</span> <span class="o">=</span> <span class="n">value</span>   
100        <span class="k">elif</span> <span class="n">name</span> <span class="o">==</span> <span class="s">&quot;_engine&quot;</span><span class="p">:</span>
101            <span class="bp">self</span><span class="o">.</span><span class="n">__dict__</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
102            <span class="k">if</span> <span class="nb">hasattr</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="s">&quot;fitter_id&quot;</span><span class="p">)</span> <span class="ow">and</span> <span class="bp">self</span><span class="o">.</span><span class="n">fitter_id</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
103                <span class="bp">self</span><span class="o">.</span><span class="n">_engine</span><span class="o">.</span><span class="n">fitter_id</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">fitter_id</span>
104        <span class="k">else</span><span class="p">:</span>
105            <span class="bp">self</span><span class="o">.</span><span class="n">__dict__</span><span class="p">[</span><span class="n">name</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
106               
107<div class="viewcode-block" id="Fit.set_engine"><a class="viewcode-back" href="../../../dev/api/sas.fit.html#sas.fit.Fitting.Fit.set_engine">[docs]</a>    <span class="k">def</span> <span class="nf">set_engine</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">word</span><span class="p">,</span> <span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">):</span>
108        <span class="sd">&quot;&quot;&quot;</span>
109<span class="sd">        Select the type of Fit </span>
110<span class="sd">        </span>
111<span class="sd">        :param word: the keyword to select the fit type </span>
112<span class="sd">        </span>
113<span class="sd">        :raise: if the user does not enter &#39;scipy&#39; or &#39;park&#39;,</span>
114<span class="sd">             a valueError is raised </span>
115<span class="sd">             </span>
116<span class="sd">        &quot;&quot;&quot;</span>
117        <span class="k">try</span><span class="p">:</span>
118            <span class="bp">self</span><span class="o">.</span><span class="n">_engine</span> <span class="o">=</span> <span class="n">ENGINES</span><span class="p">[</span><span class="n">word</span><span class="p">](</span><span class="o">*</span><span class="n">args</span><span class="p">,</span> <span class="o">**</span><span class="n">kw</span><span class="p">)</span>
119        <span class="k">except</span> <span class="ne">KeyError</span><span class="p">,</span> <span class="n">exc</span><span class="p">:</span>
120            <span class="k">raise</span> <span class="ne">KeyError</span><span class="p">(</span><span class="s">&quot;fit engine should be one of scipy, park or bumps&quot;</span><span class="p">)</span>
121</div>
122<div class="viewcode-block" id="Fit.fit"><a class="viewcode-back" href="../../../dev/api/sas.fit.html#sas.fit.Fitting.Fit.fit">[docs]</a>    <span class="k">def</span> <span class="nf">fit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">msg_q</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">q</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">handler</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> 
123                        <span class="n">curr_thread</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> 
124                        <span class="n">ftol</span><span class="o">=</span><span class="mf">1.49012e-8</span><span class="p">,</span>
125                        <span class="n">reset_flag</span><span class="o">=</span><span class="bp">False</span><span class="p">):</span>
126        <span class="sd">&quot;&quot;&quot;Perform the fit &quot;&quot;&quot;</span>
127        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_engine</span><span class="o">.</span><span class="n">fit</span><span class="p">(</span><span class="n">msg_q</span><span class="o">=</span><span class="n">msg_q</span><span class="p">,</span> 
128                                <span class="n">q</span><span class="o">=</span><span class="n">q</span><span class="p">,</span> <span class="n">handler</span><span class="o">=</span><span class="n">handler</span><span class="p">,</span> <span class="n">curr_thread</span><span class="o">=</span><span class="n">curr_thread</span><span class="p">,</span>
129                                <span class="n">ftol</span><span class="o">=</span><span class="n">ftol</span><span class="p">,</span> <span class="n">reset_flag</span><span class="o">=</span><span class="n">reset_flag</span><span class="p">)</span>
130     </div>
131<div class="viewcode-block" id="Fit.set_model"><a class="viewcode-back" href="../../../dev/api/sas.fit.html#sas.fit.Fitting.Fit.set_model">[docs]</a>    <span class="k">def</span> <span class="nf">set_model</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">model</span><span class="p">,</span> <span class="nb">id</span><span class="p">,</span> <span class="n">pars</span><span class="o">=</span><span class="p">[],</span> <span class="n">constraints</span><span class="o">=</span><span class="p">[],</span> <span class="n">data</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
132        <span class="sd">&quot;&quot;&quot;</span>
133<span class="sd">        store a model model to fit at the position id of the fit engine</span>
134<span class="sd">        &quot;&quot;&quot;</span>
135        <span class="bp">self</span><span class="o">.</span><span class="n">_engine</span><span class="o">.</span><span class="n">set_model</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="nb">id</span><span class="p">,</span> <span class="n">pars</span><span class="p">,</span> <span class="n">constraints</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="n">data</span><span class="p">)</span>
136   </div>
137<div class="viewcode-block" id="Fit.set_data"><a class="viewcode-back" href="../../../dev/api/sas.fit.html#sas.fit.Fitting.Fit.set_data">[docs]</a>    <span class="k">def</span> <span class="nf">set_data</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="p">,</span> <span class="nb">id</span><span class="p">,</span> <span class="n">smearer</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">qmin</span><span class="o">=</span><span class="bp">None</span><span class="p">,</span> <span class="n">qmax</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
138        <span class="sd">&quot;&quot;&quot;</span>
139<span class="sd">        Store data to fit at the psotion id of the fit engine</span>
140<span class="sd">        </span>
141<span class="sd">        :param data: data to fit</span>
142<span class="sd">        :param smearer: smearerobject to smear data</span>
143<span class="sd">        :param qmin: the minimum q range to fit </span>
144<span class="sd">        :param qmax: the minimum q range to fit</span>
145<span class="sd">        </span>
146<span class="sd">        &quot;&quot;&quot;</span>
147        <span class="bp">self</span><span class="o">.</span><span class="n">_engine</span><span class="o">.</span><span class="n">set_data</span><span class="p">(</span><span class="n">data</span><span class="p">,</span> <span class="nb">id</span><span class="p">,</span> <span class="n">smearer</span><span class="p">,</span> <span class="n">qmin</span><span class="p">,</span> <span class="n">qmax</span><span class="p">)</span>
148        </div>
149<div class="viewcode-block" id="Fit.get_model"><a class="viewcode-back" href="../../../dev/api/sas.fit.html#sas.fit.Fitting.Fit.get_model">[docs]</a>    <span class="k">def</span> <span class="nf">get_model</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">id</span><span class="p">):</span>
150        <span class="sd">&quot;&quot;&quot; return list of data&quot;&quot;&quot;</span>
151        <span class="bp">self</span><span class="o">.</span><span class="n">_engine</span><span class="o">.</span><span class="n">get_model</span><span class="p">(</span><span class="nb">id</span><span class="p">)</span>
152
153</div>
154<div class="viewcode-block" id="Fit.remove_fit_problem"><a class="viewcode-back" href="../../../dev/api/sas.fit.html#sas.fit.Fitting.Fit.remove_fit_problem">[docs]</a>    <span class="k">def</span> <span class="nf">remove_fit_problem</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">id</span><span class="p">):</span>
155        <span class="sd">&quot;&quot;&quot;remove fitarrange in id&quot;&quot;&quot;</span>
156        <span class="bp">self</span><span class="o">.</span><span class="n">_engine</span><span class="o">.</span><span class="n">remove_fit_problem</span><span class="p">(</span><span class="nb">id</span><span class="p">)</span>
157        </div>
158<div class="viewcode-block" id="Fit.select_problem_for_fit"><a class="viewcode-back" href="../../../dev/api/sas.fit.html#sas.fit.Fitting.Fit.select_problem_for_fit">[docs]</a>    <span class="k">def</span> <span class="nf">select_problem_for_fit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">id</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
159        <span class="sd">&quot;&quot;&quot;</span>
160<span class="sd">        select a couple of model and data at the id position in dictionary</span>
161<span class="sd">        and set in self.selected value to value</span>
162<span class="sd">        </span>
163<span class="sd">        :param value: the value to allow fitting.</span>
164<span class="sd">             can only have the value one or zero</span>
165<span class="sd">        &quot;&quot;&quot;</span>
166        <span class="bp">self</span><span class="o">.</span><span class="n">_engine</span><span class="o">.</span><span class="n">select_problem_for_fit</span><span class="p">(</span><span class="nb">id</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
167        </div>
168<div class="viewcode-block" id="Fit.get_problem_to_fit"><a class="viewcode-back" href="../../../dev/api/sas.fit.html#sas.fit.Fitting.Fit.get_problem_to_fit">[docs]</a>    <span class="k">def</span> <span class="nf">get_problem_to_fit</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="nb">id</span><span class="p">):</span>
169        <span class="sd">&quot;&quot;&quot;</span>
170<span class="sd">        return the self.selected value of the fit problem of id</span>
171<span class="sd">           </span>
172<span class="sd">        :param id: the id of the problem</span>
173<span class="sd">        </span>
174<span class="sd">        &quot;&quot;&quot;</span>
175        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_engine</span><span class="o">.</span><span class="n">get_problem_to_fit</span><span class="p">(</span><span class="nb">id</span><span class="p">)</span></div></div>
176</pre></div>
177
178          </div>
179        </div>
180      </div>
181      <div class="sphinxsidebar">
182        <div class="sphinxsidebarwrapper">
183<div id="searchbox" style="display: none">
184  <h3>Quick search</h3>
185    <form class="search" action="../../../search.html" method="get">
186      <input type="text" name="q" />
187      <input type="submit" value="Go" />
188      <input type="hidden" name="check_keywords" value="yes" />
189      <input type="hidden" name="area" value="default" />
190    </form>
191    <p class="searchtip" style="font-size: 90%">
192    Enter search terms or a module, class or function name.
193    </p>
194</div>
195<script type="text/javascript">$('#searchbox').show(0);</script>
196        </div>
197      </div>
198      <div class="clearer"></div>
199    </div>
200    <div class="related">
201      <h3>Navigation</h3>
202      <ul>
203        <li class="right" style="margin-right: 10px">
204          <a href="../../../genindex.html" title="General Index"
205             >index</a></li>
206        <li class="right" >
207          <a href="../../../py-modindex.html" title="Python Module Index"
208             >modules</a> |</li>
209        <li><a href="../../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
210          <li><a href="../../index.html" >Module code</a> &raquo;</li> 
211      </ul>
212    </div>
213    <div class="footer">
214        &copy; Copyright 2013, The SasView Project.
215      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
216    </div>
217  </body>
218</html>
Note: See TracBrowser for help on using the repository browser.