source: sasview/_modules/sas/plottools/fittings.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: 15.4 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.plottools.fittings &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.plottools.fittings</h1><div class="highlight"><pre>
51<span class="sd">&quot;&quot;&quot;</span>
52<span class="sd">&quot;&quot;&quot;</span>
53<span class="kn">from</span> <span class="nn">scipy</span> <span class="kn">import</span> <span class="n">optimize</span>
54
55
56<div class="viewcode-block" id="Parameter"><a class="viewcode-back" href="../../../dev/api/sas.plottools.html#sas.plottools.fittings.Parameter">[docs]</a><span class="k">class</span> <span class="nc">Parameter</span><span class="p">:</span>
57    <span class="sd">&quot;&quot;&quot;</span>
58<span class="sd">    Class to handle model parameters</span>
59<span class="sd">    &quot;&quot;&quot;</span>
60    <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">model</span><span class="p">,</span> <span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="o">=</span><span class="bp">None</span><span class="p">):</span>
61            <span class="bp">self</span><span class="o">.</span><span class="n">model</span> <span class="o">=</span> <span class="n">model</span>
62            <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="n">name</span>
63            <span class="k">if</span> <span class="ow">not</span> <span class="n">value</span> <span class="o">==</span> <span class="bp">None</span><span class="p">:</span>
64                <span class="bp">self</span><span class="o">.</span><span class="n">model</span><span class="o">.</span><span class="n">setParam</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
65           
66<div class="viewcode-block" id="Parameter.set"><a class="viewcode-back" href="../../../dev/api/sas.plottools.html#sas.plottools.fittings.Parameter.set">[docs]</a>    <span class="k">def</span> <span class="nf">set</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">value</span><span class="p">):</span>
67        <span class="sd">&quot;&quot;&quot;</span>
68<span class="sd">            Set the value of the parameter</span>
69<span class="sd">        &quot;&quot;&quot;</span>
70        <span class="bp">self</span><span class="o">.</span><span class="n">model</span><span class="o">.</span><span class="n">setParam</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">,</span> <span class="n">value</span><span class="p">)</span>
71</div>
72    <span class="k">def</span> <span class="nf">__call__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
73        <span class="sd">&quot;&quot;&quot;</span>
74<span class="sd">            Return the current value of the parameter</span>
75<span class="sd">        &quot;&quot;&quot;</span>
76        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">model</span><span class="o">.</span><span class="n">getParam</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">)</span>
77   
78    </div>
79<div class="viewcode-block" id="sasfit"><a class="viewcode-back" href="../../../dev/api/sas.plottools.html#sas.plottools.fittings.sasfit">[docs]</a><span class="k">def</span> <span class="nf">sasfit</span><span class="p">(</span><span class="n">model</span><span class="p">,</span> <span class="n">pars</span><span class="p">,</span> <span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">,</span> <span class="n">err_y</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>
80    <span class="sd">&quot;&quot;&quot;</span>
81<span class="sd">    Fit function</span>
82<span class="sd">    </span>
83<span class="sd">    :param model: sas model object</span>
84<span class="sd">    :param pars: list of parameters</span>
85<span class="sd">    :param x: vector of x data</span>
86<span class="sd">    :param y: vector of y data</span>
87<span class="sd">    :param err_y: vector of y errors</span>
88<span class="sd">    &quot;&quot;&quot;</span>
89    <span class="k">def</span> <span class="nf">f</span><span class="p">(</span><span class="n">params</span><span class="p">):</span>
90        <span class="sd">&quot;&quot;&quot;</span>
91<span class="sd">        Calculates the vector of residuals for each point</span>
92<span class="sd">        in y for a given set of input parameters.</span>
93<span class="sd">        </span>
94<span class="sd">        :param params: list of parameter values</span>
95<span class="sd">        :return: vector of residuals</span>
96<span class="sd">        &quot;&quot;&quot;</span>
97        <span class="n">i</span> <span class="o">=</span> <span class="mi">0</span>
98        <span class="k">for</span> <span class="n">p</span> <span class="ow">in</span> <span class="n">pars</span><span class="p">:</span>
99            <span class="n">p</span><span class="o">.</span><span class="n">set</span><span class="p">(</span><span class="n">params</span><span class="p">[</span><span class="n">i</span><span class="p">])</span>
100            <span class="n">i</span> <span class="o">+=</span> <span class="mi">1</span>
101       
102        <span class="n">residuals</span> <span class="o">=</span> <span class="p">[]</span>
103        <span class="k">for</span> <span class="n">j</span> <span class="ow">in</span> <span class="nb">range</span><span class="p">(</span><span class="nb">len</span><span class="p">(</span><span class="n">x</span><span class="p">)):</span>
104            <span class="k">if</span> <span class="n">x</span><span class="p">[</span><span class="n">j</span><span class="p">]</span> <span class="o">&gt;=</span> <span class="n">qmin</span> <span class="ow">and</span> <span class="n">x</span><span class="p">[</span><span class="n">j</span><span class="p">]</span> <span class="o">&lt;=</span> <span class="n">qmax</span><span class="p">:</span>
105                <span class="n">residuals</span><span class="o">.</span><span class="n">append</span><span class="p">((</span><span class="n">y</span><span class="p">[</span><span class="n">j</span><span class="p">]</span> <span class="o">-</span> <span class="n">model</span><span class="o">.</span><span class="n">runXY</span><span class="p">(</span><span class="n">x</span><span class="p">[</span><span class="n">j</span><span class="p">]))</span> <span class="o">/</span> <span class="n">err_y</span><span class="p">[</span><span class="n">j</span><span class="p">])</span>
106        <span class="k">return</span> <span class="n">residuals</span>
107       
108    <span class="k">def</span> <span class="nf">chi2</span><span class="p">(</span><span class="n">params</span><span class="p">):</span>
109        <span class="sd">&quot;&quot;&quot;</span>
110<span class="sd">        Calculates chi^2</span>
111<span class="sd">        </span>
112<span class="sd">        :param params: list of parameter values</span>
113<span class="sd">        </span>
114<span class="sd">        :return: chi^2</span>
115<span class="sd">        </span>
116<span class="sd">        &quot;&quot;&quot;</span>
117        <span class="nb">sum</span> <span class="o">=</span> <span class="mi">0</span>
118        <span class="n">res</span> <span class="o">=</span> <span class="n">f</span><span class="p">(</span><span class="n">params</span><span class="p">)</span>
119        <span class="k">for</span> <span class="n">item</span> <span class="ow">in</span> <span class="n">res</span><span class="p">:</span>
120            <span class="nb">sum</span> <span class="o">+=</span> <span class="n">item</span> <span class="o">*</span> <span class="n">item</span>
121        <span class="k">return</span> <span class="nb">sum</span>
122       
123    <span class="n">p</span> <span class="o">=</span> <span class="p">[</span><span class="n">param</span><span class="p">()</span> <span class="k">for</span> <span class="n">param</span> <span class="ow">in</span> <span class="n">pars</span><span class="p">]</span>
124    <span class="n">out</span><span class="p">,</span> <span class="n">cov_x</span><span class="p">,</span> <span class="n">info</span><span class="p">,</span> <span class="n">mesg</span><span class="p">,</span> <span class="n">success</span> <span class="o">=</span> <span class="n">optimize</span><span class="o">.</span><span class="n">leastsq</span><span class="p">(</span><span class="n">f</span><span class="p">,</span> <span class="n">p</span><span class="p">,</span> <span class="n">full_output</span><span class="o">=</span><span class="mi">1</span><span class="p">)</span>
125    <span class="c"># Calculate chi squared</span>
126    <span class="k">if</span> <span class="nb">len</span><span class="p">(</span><span class="n">pars</span><span class="p">)</span> <span class="o">&gt;</span> <span class="mi">1</span><span class="p">:</span>
127        <span class="n">chisqr</span> <span class="o">=</span> <span class="n">chi2</span><span class="p">(</span><span class="n">out</span><span class="p">)</span>
128    <span class="k">elif</span> <span class="nb">len</span><span class="p">(</span><span class="n">pars</span><span class="p">)</span> <span class="o">==</span> <span class="mi">1</span><span class="p">:</span>
129        <span class="n">chisqr</span> <span class="o">=</span> <span class="n">chi2</span><span class="p">([</span><span class="n">out</span><span class="p">])</span>
130       
131    <span class="k">return</span> <span class="n">chisqr</span><span class="p">,</span> <span class="n">out</span><span class="p">,</span> <span class="n">cov_x</span>
132
133</div>
134<div class="viewcode-block" id="calcCommandline"><a class="viewcode-back" href="../../../dev/api/sas.plottools.html#sas.plottools.fittings.calcCommandline">[docs]</a><span class="k">def</span> <span class="nf">calcCommandline</span><span class="p">(</span><span class="n">event</span><span class="p">):</span>
135    <span class="c">#Testing implementation</span>
136    <span class="c"># Fit a Line model</span>
137    <span class="kn">from</span> <span class="nn">LineModel</span> <span class="kn">import</span> <span class="n">LineModel</span>
138    <span class="n">line</span> <span class="o">=</span> <span class="n">LineModel</span><span class="p">()</span>
139    <span class="n">cstA</span> <span class="o">=</span> <span class="n">Parameter</span><span class="p">(</span><span class="n">line</span><span class="p">,</span> <span class="s">&#39;A&#39;</span><span class="p">,</span> <span class="n">event</span><span class="o">.</span><span class="n">cstA</span><span class="p">)</span>
140    <span class="n">cstB</span> <span class="o">=</span> <span class="n">Parameter</span><span class="p">(</span><span class="n">line</span><span class="p">,</span> <span class="s">&#39;B&#39;</span><span class="p">,</span> <span class="n">event</span><span class="o">.</span><span class="n">cstB</span><span class="p">)</span>
141    <span class="n">y</span> <span class="o">=</span> <span class="n">line</span><span class="o">.</span><span class="n">run</span><span class="p">()</span>
142    <span class="n">chisqr</span><span class="p">,</span> <span class="n">out</span><span class="p">,</span> <span class="n">cov</span> <span class="o">=</span> <span class="n">sasfit</span><span class="p">(</span><span class="n">line</span><span class="p">,</span> <span class="p">[</span><span class="n">cstA</span><span class="p">,</span> <span class="n">cstB</span><span class="p">],</span> <span class="n">event</span><span class="o">.</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">,</span> <span class="mi">0</span><span class="p">)</span>
143    <span class="c"># print &quot;Output parameters:&quot;, out</span>
144    <span class="k">print</span> <span class="s">&quot;The right answer is [70.0, 1.0]&quot;</span>
145    <span class="k">print</span> <span class="n">chisqr</span><span class="p">,</span> <span class="n">out</span><span class="p">,</span> <span class="n">cov</span></div>
146</pre></div>
147
148          </div>
149        </div>
150      </div>
151      <div class="sphinxsidebar">
152        <div class="sphinxsidebarwrapper">
153<div id="searchbox" style="display: none">
154  <h3>Quick search</h3>
155    <form class="search" action="../../../search.html" method="get">
156      <input type="text" name="q" />
157      <input type="submit" value="Go" />
158      <input type="hidden" name="check_keywords" value="yes" />
159      <input type="hidden" name="area" value="default" />
160    </form>
161    <p class="searchtip" style="font-size: 90%">
162    Enter search terms or a module, class or function name.
163    </p>
164</div>
165<script type="text/javascript">$('#searchbox').show(0);</script>
166        </div>
167      </div>
168      <div class="clearer"></div>
169    </div>
170    <div class="related">
171      <h3>Navigation</h3>
172      <ul>
173        <li class="right" style="margin-right: 10px">
174          <a href="../../../genindex.html" title="General Index"
175             >index</a></li>
176        <li class="right" >
177          <a href="../../../py-modindex.html" title="Python Module Index"
178             >modules</a> |</li>
179        <li><a href="../../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
180          <li><a href="../../index.html" >Module code</a> &raquo;</li> 
181      </ul>
182    </div>
183    <div class="footer">
184        &copy; Copyright 2013, The SasView Project.
185      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
186    </div>
187  </body>
188</html>
Note: See TracBrowser for help on using the repository browser.