source: sasview/_modules/sas/perspectives/fitting/plugin_models/polynomial5.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.1 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.perspectives.fitting.plugin_models.polynomial5 &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="sas.perspectives.fitting" href="../../fitting.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" >Module code</a> &raquo;</li>
42          <li><a href="../../fitting.html" accesskey="U">sas.perspectives.fitting</a> &raquo;</li> 
43      </ul>
44    </div> 
45
46    <div class="document">
47      <div class="documentwrapper">
48        <div class="bodywrapper">
49          <div class="body">
50           
51  <h1>Source code for sas.perspectives.fitting.plugin_models.polynomial5</h1><div class="highlight"><pre>
52<span class="sd">&quot;&quot;&quot;</span>
53<span class="sd">Test plug-in model</span>
54<span class="sd">These are links of available functions:</span>
55
56<span class="sd">http://docs.python.org/library/math.html</span>
57<span class="sd">http://www.scipy.org/Numpy_Functions_by_Category</span>
58<span class="sd">&quot;&quot;&quot;</span>
59
60<span class="sd">&quot;&quot;&quot;</span>
61<span class="sd">## *****************************************************************************</span>
62<span class="sd">Please select the &#39;Compile&#39; from the menubar after the modification and saving.</span>
63<span class="sd">Note that we recommend to save the file as a different file name.</span>
64<span class="sd">Otherwise, it could be removed in the future on re-installation of the SasView.</span>
65<span class="sd">## *****************************************************************************</span>
66<span class="sd">&quot;&quot;&quot;</span>
67<span class="kn">from</span> <span class="nn">sas.models.pluginmodel</span> <span class="kn">import</span> <span class="n">Model1DPlugin</span>  <span class="c">##DO NOT CHANGE THIS LINE!!!</span>
68
69<span class="c">## FOR MORE INFORMATION CHECK http://docs.python.org/library/math.html      </span>
70<span class="c">## AND http://www.scipy.org/Numpy_Functions_by_Category</span>
71<span class="kn">import</span> <span class="nn">math</span>                    <span class="c">##DO NOT CHANGE THIS LINE!!!</span>
72<span class="kn">import</span> <span class="nn">numpy</span>                   <span class="c">##DO NOT CHANGE THIS LINE!!!</span>
73<span class="kn">import</span> <span class="nn">os</span>
74<span class="kn">import</span> <span class="nn">sys</span>
75<span class="c">## &lt;-----  SIGN DEFINES WHERE YOU CAN MODIFY THE CODE</span>
76
77<div class="viewcode-block" id="Model"><a class="viewcode-back" href="../../../../../dev/api/sas.perspectives.fitting.plugin_models.html#sas.perspectives.fitting.plugin_models.polynomial5.Model">[docs]</a><span class="k">class</span> <span class="nc">Model</span><span class="p">(</span><span class="n">Model1DPlugin</span><span class="p">):</span> <span class="c">##DO NOT CHANGE THIS LINE!!!</span>
78    <span class="sd">&quot;&quot;&quot;</span>
79<span class="sd">    ##YOU CAN BE MODIFY ANYTHING BETWEEN &quot;&quot;&quot;</span> <span class="s">&quot;&quot;&quot;</span>
80<span class="s">    ##DESCRIPTION OF MODEL PLUG-IN GOES HERE</span>
81<span class="s">    </span>
82<span class="s">    ##EXAMPLE: Class that evaluates a polynomial model. </span>
83<span class="s">    &quot;&quot;&quot;</span>
84    <span class="n">name</span> <span class="o">=</span> <span class="s">&quot;&quot;</span> 
85                               
86    <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="c">##DO NOT CHANGE THIS LINE!!!</span>
87        <span class="sd">&quot;&quot;&quot;</span>
88<span class="sd">        Initialization</span>
89<span class="sd">        &quot;&quot;&quot;</span>
90        <span class="n">Model1DPlugin</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">name</span><span class="o">=</span><span class="bp">self</span><span class="o">.</span><span class="n">name</span><span class="p">)</span> <span class="c">##DO NOT CHANGE THIS LINE!!!</span>
91       
92        <span class="c">## HERE WE DEFINE THE PARAM NAME AND ITS INITIAL VALUE </span>
93        <span class="c">## YOU CAN MODIFY THE LINE BELLOW.CHANGE WORD BETWEEN &#39; &#39; AND NUMBER                                                      </span>
94        <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;A&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="mf">0.1</span>       <span class="c">## &lt;-----                </span>
95        <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;B&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="mf">10.0</span>      <span class="c">## &lt;-----                 </span>
96        <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;C&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="mf">0.0</span>       <span class="c">## &lt;-----                </span>
97        <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;D&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="mf">0.0</span>       <span class="c">## &lt;-----                    </span>
98        <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;E&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="mf">0.0</span>       <span class="c">## &lt;-----                  </span>
99        <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;F&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="mf">0.0</span>       <span class="c">## &lt;-----   </span>
100        <span class="c"># Set the name same as the file name</span>
101        <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">get_fname</span><span class="p">()</span>     <span class="c">##DO NOT CHANGE THIS LINE!!!</span>
102        <span class="c">## YOU CAN MODIFY THE LINE BELLOW.MODIFY WORDS BETWEEN &quot;&quot;&quot;   &quot;&quot;&quot;  ONLY!!!!</span>
103        <span class="bp">self</span><span class="o">.</span><span class="n">description</span> <span class="o">=</span> <span class="s">&quot;&quot;&quot;</span>
104<span class="s">            a + b * x + c * math.pow(x,2) + d * math.pow(x,3) </span><span class="se">\n</span><span class="s"></span>
105<span class="s">             + e * math.pow(x,4) + f * math.pow(x,5)  </span>
106<span class="s">        &quot;&quot;&quot;</span>                        <span class="c">## &lt;-----   </span>
107        <span class="c">## DEFINE DEFAULT DETAILS</span>
108        <span class="bp">self</span><span class="o">.</span><span class="n">set_details</span><span class="p">()</span>      <span class="c">##DO NOT DELETE OR CHANGE THIS LINE!!!</span>
109       
110        <span class="c">## IN THIS EXAMPLE THE FUNTION IS:</span>
111        <span class="c">## F(x)=A+B*x+C*x^2+D*x^3+E*x^4+F*x^5             </span>
112   
113<div class="viewcode-block" id="Model.function"><a class="viewcode-back" href="../../../../../dev/api/sas.perspectives.fitting.plugin_models.html#sas.perspectives.fitting.plugin_models.polynomial5.Model.function">[docs]</a>    <span class="k">def</span> <span class="nf">function</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span> <span class="o">=</span> <span class="mf">0.0</span><span class="p">):</span> <span class="c">##DO NOT CHANGE THIS LINE!!!</span>
114        <span class="sd">&quot;&quot;&quot; </span>
115<span class="sd">        Evaluate the model</span>
116<span class="sd">        :param x: input x</span>
117<span class="sd">        :return: function value</span>
118<span class="sd">        &quot;&quot;&quot;</span>
119        <span class="c">## DEFINE YOUR FUNCTION HERE.</span>
120        <span class="c">## YOU CAN ERASE EVERYTHING BELLOW FOR YOUR OWN FUNCTION</span>
121        <span class="c">#Redefine parameters as local parameters, or skip and use long name</span>
122        <span class="n">a</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;A&#39;</span><span class="p">]</span>       <span class="c">## &lt;-----   </span>
123        <span class="n">b</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;B&#39;</span><span class="p">]</span>       <span class="c">## &lt;-----   </span>
124        <span class="n">c</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;C&#39;</span><span class="p">]</span>       <span class="c">## &lt;-----   </span>
125        <span class="n">d</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;D&#39;</span><span class="p">]</span>       <span class="c">## &lt;-----   </span>
126        <span class="n">e</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;E&#39;</span><span class="p">]</span>       <span class="c">## &lt;-----   </span>
127        <span class="n">f</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;F&#39;</span><span class="p">]</span>       <span class="c">## &lt;-----   </span>
128 
129        <span class="c">##THIS OUR FUNCTION TEMPLATE</span>
130        <span class="n">poly</span> <span class="o">=</span> <span class="n">a</span> <span class="o">+</span> <span class="n">b</span> <span class="o">*</span> <span class="n">x</span> <span class="o">+</span> <span class="n">c</span> <span class="o">*</span> <span class="n">math</span><span class="o">.</span><span class="n">pow</span><span class="p">(</span><span class="n">x</span><span class="p">,</span><span class="mi">2</span><span class="p">)</span> <span class="o">+</span> <span class="n">d</span> <span class="o">*</span> <span class="n">math</span><span class="o">.</span><span class="n">pow</span><span class="p">(</span><span class="n">x</span><span class="p">,</span><span class="mi">3</span><span class="p">)</span> \
131                <span class="o">+</span> <span class="n">e</span> <span class="o">*</span> <span class="n">math</span><span class="o">.</span><span class="n">pow</span><span class="p">(</span><span class="n">x</span><span class="p">,</span><span class="mi">4</span><span class="p">)</span> <span class="o">+</span> <span class="n">f</span> <span class="o">*</span> <span class="n">math</span><span class="o">.</span><span class="n">pow</span><span class="p">(</span><span class="n">x</span><span class="p">,</span><span class="mi">5</span><span class="p">)</span>              <span class="c">## &lt;-----                </span>
132       
133        <span class="c">#(Just note: In Python, indentation defines the belongings </span>
134        <span class="c"># of &#39;if&#39;, &#39;for&#39;, and so on..)</span>
135        <span class="c">#(lim x --&gt; 0) </span>
136        <span class="k">if</span> <span class="n">x</span> <span class="o">==</span> <span class="mi">0</span><span class="p">:</span>                          <span class="c">## &lt;-----   </span>
137            <span class="n">result</span> <span class="o">=</span> <span class="n">a</span>                      <span class="c">## &lt;-----   </span>
138        <span class="k">else</span><span class="p">:</span>                               <span class="c">## &lt;-----   </span>
139            <span class="n">result</span> <span class="o">=</span> <span class="n">poly</span>                   <span class="c">## &lt;-----    </span>
140
141        <span class="k">return</span> <span class="n">result</span>       <span class="c">## MODIFY ONLY RESULT. DON&#39;T DELETE RETURN!!!!</span>
142   
143    <span class="c">## DO NOT MODIFY THE FOLLOWING LINES!!!!!!!!!!!!!!!!       </span></div>
144<div class="viewcode-block" id="Model.get_fname"><a class="viewcode-back" href="../../../../../dev/api/sas.perspectives.fitting.plugin_models.html#sas.perspectives.fitting.plugin_models.polynomial5.Model.get_fname">[docs]</a>    <span class="k">def</span> <span class="nf">get_fname</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
145        <span class="sd">&quot;&quot;&quot;</span>
146<span class="sd">        Get the model name same as the file name</span>
147<span class="sd">        &quot;&quot;&quot;</span>
148        <span class="n">path</span> <span class="o">=</span> <span class="n">sys</span><span class="o">.</span><span class="n">_getframe</span><span class="p">()</span><span class="o">.</span><span class="n">f_code</span><span class="o">.</span><span class="n">co_filename</span>
149        <span class="n">basename</span>  <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">basename</span><span class="p">(</span><span class="n">path</span><span class="p">)</span>
150        <span class="n">name</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">os</span><span class="o">.</span><span class="n">path</span><span class="o">.</span><span class="n">splitext</span><span class="p">(</span><span class="n">basename</span><span class="p">)</span>
151        <span class="k">return</span> <span class="n">name</span>
152           
153<span class="c">###############################################################################</span>
154<span class="c">## THIS IS FOR TEST. DO NOT MODIFY THE FOLLOWING LINES!!!!!!!!!!!!!!!!       </span></div></div>
155<span class="k">if</span> <span class="n">__name__</span> <span class="o">==</span> <span class="s">&quot;__main__&quot;</span><span class="p">:</span> 
156    <span class="n">m</span><span class="o">=</span> <span class="n">Model</span><span class="p">()</span> 
157    <span class="n">out1</span> <span class="o">=</span> <span class="n">m</span><span class="o">.</span><span class="n">runXY</span><span class="p">(</span><span class="mf">0.0</span><span class="p">)</span>
158    <span class="n">out2</span> <span class="o">=</span> <span class="n">m</span><span class="o">.</span><span class="n">runXY</span><span class="p">(</span><span class="mf">0.01</span><span class="p">)</span>
159    <span class="n">isfine1</span> <span class="o">=</span> <span class="n">numpy</span><span class="o">.</span><span class="n">isfinite</span><span class="p">(</span><span class="n">out1</span><span class="p">)</span>
160    <span class="n">isfine2</span> <span class="o">=</span> <span class="n">numpy</span><span class="o">.</span><span class="n">isfinite</span><span class="p">(</span><span class="n">out2</span><span class="p">)</span>
161    <span class="k">print</span> <span class="s">&quot;Testing the value at Q = 0.0:&quot;</span>
162    <span class="k">print</span> <span class="n">out1</span><span class="p">,</span> <span class="s">&quot; : finite? &quot;</span><span class="p">,</span> <span class="n">isfine1</span>
163    <span class="k">print</span> <span class="s">&quot;Testing the value at Q = 0.01:&quot;</span>
164    <span class="k">print</span> <span class="n">out2</span><span class="p">,</span> <span class="s">&quot; : finite? &quot;</span><span class="p">,</span> <span class="n">isfine2</span>
165    <span class="k">if</span> <span class="n">isfine1</span> <span class="ow">and</span> <span class="n">isfine2</span><span class="p">:</span>
166        <span class="k">print</span> <span class="s">&quot;===&gt; Simple Test: Passed!&quot;</span>
167    <span class="k">else</span><span class="p">:</span>
168        <span class="k">print</span> <span class="s">&quot;===&gt; Simple Test: Failed!&quot;</span>
169</pre></div>
170
171          </div>
172        </div>
173      </div>
174      <div class="sphinxsidebar">
175        <div class="sphinxsidebarwrapper">
176<div id="searchbox" style="display: none">
177  <h3>Quick search</h3>
178    <form class="search" action="../../../../../search.html" method="get">
179      <input type="text" name="q" />
180      <input type="submit" value="Go" />
181      <input type="hidden" name="check_keywords" value="yes" />
182      <input type="hidden" name="area" value="default" />
183    </form>
184    <p class="searchtip" style="font-size: 90%">
185    Enter search terms or a module, class or function name.
186    </p>
187</div>
188<script type="text/javascript">$('#searchbox').show(0);</script>
189        </div>
190      </div>
191      <div class="clearer"></div>
192    </div>
193    <div class="related">
194      <h3>Navigation</h3>
195      <ul>
196        <li class="right" style="margin-right: 10px">
197          <a href="../../../../../genindex.html" title="General Index"
198             >index</a></li>
199        <li class="right" >
200          <a href="../../../../../py-modindex.html" title="Python Module Index"
201             >modules</a> |</li>
202        <li><a href="../../../../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
203          <li><a href="../../../../index.html" >Module code</a> &raquo;</li>
204          <li><a href="../../fitting.html" >sas.perspectives.fitting</a> &raquo;</li> 
205      </ul>
206    </div>
207    <div class="footer">
208        &copy; Copyright 2013, The SasView Project.
209      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
210    </div>
211  </body>
212</html>
Note: See TracBrowser for help on using the repository browser.