source: sasview/_modules/sas/perspectives/fitting/plugin_models/sph_bessel_jn.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.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.perspectives.fitting.plugin_models.sph_bessel_jn &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.sph_bessel_jn</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
68<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>
69<span class="kn">import</span> <span class="nn">math</span>                  <span class="c">##DO NOT CHANGE THIS LINE!!!</span>
70<span class="kn">import</span> <span class="nn">numpy</span>                 <span class="c">##DO NOT CHANGE THIS LINE!!!</span>
71<span class="kn">import</span> <span class="nn">scipy.special</span>            <span class="c">##CHANGE THIS LINE WITH CAUTION!!!</span>
72<span class="kn">import</span> <span class="nn">os</span>
73<span class="kn">import</span> <span class="nn">sys</span>
74<span class="c">##PLEASE READ COMMENTS CAREFULLY !!! COMMENT ARE IN CAPITAL LETTERS AND AFTER ##</span>
75<span class="c">## THESE COMMENTS ARE THERE TO GUIDE YOU. YOU CAN REMOVE THEM ONLY WHEN YOU ARE</span>
76<span class="c">## CONFORTABLE ENOUGH WITH OUR MODEL PLUGIN OPTION</span>
77
78
79<span class="c">## &lt;-----  SIGN DEFINES WHERE YOU CAN MODIFY THE CODE</span>
80
81<div class="viewcode-block" id="Model"><a class="viewcode-back" href="../../../../../dev/api/sas.perspectives.fitting.plugin_models.html#sas.perspectives.fitting.plugin_models.sph_bessel_jn.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>
82    <span class="sd">&quot;&quot;&quot;</span>
83<span class="sd">    ##YOU CAN BE MODIFY ANYTHING BETWEEN &quot;&quot;&quot;</span> <span class="s">&quot;&quot;&quot;</span>
84<span class="s">    ##DESCRIPTION OF MODEL PLUG-IN GOES HERE</span>
85<span class="s">    </span>
86<span class="s">    ##EXAMPLE: Class that evaluates a polynomial model. </span>
87<span class="s">    &quot;&quot;&quot;</span>
88    <span class="n">name</span> <span class="o">=</span> <span class="s">&quot;&quot;</span> 
89                               
90    <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>
91        <span class="sd">&quot;&quot;&quot;</span>
92<span class="sd">        Initialization</span>
93<span class="sd">        &quot;&quot;&quot;</span>
94        <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>
95       
96        <span class="c">## EDIT PARAMETERS&#39; NAMES AND VALUE</span>
97        <span class="c">## DELETE MODIFIABLE LINE HERE WILL REDUCE THE NUMBER OF PARAMETERS</span>
98        <span class="bp">self</span><span class="o">.</span><span class="n">params</span> <span class="o">=</span> <span class="p">{}</span>                <span class="c">##DO NOT CHANGE THIS LINE!!!</span>
99        <span class="c"># Set the name same as the file name</span>
100        <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>
101        <span class="c">## YOU CAN MODIFY THE LINE BELLOW.CHANGE WORD BETWEEN &#39; &#39; AND NUMBER </span>
102        <span class="c">## YOU CAN ALSO DELETE THIS LINE</span>
103        <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">1.0</span>   <span class="c">## &lt;-----   </span>
104        <span class="c">## YOU CAN MODIFY THE LINE BELLOW.CHANGE WORD BETWEEN &#39; &#39; AND NUMBER </span>
105        <span class="c">## YOU CAN ALSO DELETE THIS LINE                                                      </span>
106        <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">1.0</span>       <span class="c">## &lt;-----   </span>
107        <span class="c">## YOU CAN MODIFY THE LINE BELLOW.CHANGE WORD BETWEEN &#39; &#39; AND NUMBER </span>
108        <span class="c">## YOU CAN ALSO DELETE THIS LINE                 </span>
109        <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">0.0</span>      <span class="c">## &lt;-----   </span>
110        <span class="c">## YOU CAN MODIFY THE LINE BELLOW.CHANGE WORD BETWEEN &#39; &#39; AND NUMBER </span>
111        <span class="c">## YOU CAN ALSO DELETE THIS LINE                 </span>
112        <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>
113        <span class="c">## YOU CAN ALSO DELETE THIS LINE                 </span>
114        <span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;n&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="mi">1</span>      <span class="c">## &lt;----- </span>
115 
116        <span class="c">## DEFINE DEFAULT DETAILS</span>
117        <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>
118       
119        <span class="c">## YOU CAN MODIFY THE LINE BELLOW.MODIFY WORDS BETWEEN &quot;&quot;&quot;   &quot;&quot;&quot;  ONLY!!!!</span>
120        <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>
121<span class="s">            Spherical Bessel Function: C*sph_jn(n, Ax+B)+D</span>
122<span class="s">                 &quot;&quot;&quot;</span>                        <span class="c">## &lt;-----   </span>
123   
124<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.sph_bessel_jn.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>
125        <span class="sd">&quot;&quot;&quot; </span>
126<span class="sd">        Evaluate the model</span>
127<span class="sd">        </span>
128<span class="sd">        :param x: input x</span>
129<span class="sd">        </span>
130<span class="sd">        :return: function value</span>
131<span class="sd">        </span>
132<span class="sd">        &quot;&quot;&quot;</span>
133        <span class="c">## ADD YOUR FUNCTION HERE.</span>
134        <span class="c">## REUSE THE PARAMETERS DEFINED PREVIOUSLY TO WRITE YOUR FUNCTION.</span>
135       
136        <span class="c">## IN THIS EXAMPLE THE FUNTION IS:</span>
137        <span class="c">## C*sph_jn(Ax+B)+D</span>
138         
139        <span class="c">## NOTE: pow IS A FUNCTION IMPORTED FROM PYTHON MATH LIBRARY</span>
140        <span class="c">## FOR MORE INFORMATION CHECK http://docs.python.org/library/math.html      </span>
141        <span class="c">## OTHER FUNCTIONS ARE ALSO </span>
142        <span class="c">###  AVAILABLE http://www.scipy.org/Numpy_Functions_by_Category</span>
143        <span class="c">## numpy FUNCTIONS ARE FOR EXPERT USER</span>
144       
145        <span class="c">## YOU CAN ERASE EVERYTHING BELLOW FOR YOUR OWN FUNCTION</span>
146        <span class="c">#Redefine parameters as local parameters</span>
147        <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>
148        <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>
149        <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>
150        <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>
151        <span class="c"># Take integer value only</span>
152        <span class="n">n</span> <span class="o">=</span> <span class="nb">int</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">params</span><span class="p">[</span><span class="s">&#39;n&#39;</span><span class="p">])</span>      <span class="c">## &lt;-----   </span>
153
154        <span class="c">##THIS OUR FUNCTION TEMPLATE</span>
155        <span class="c">#Remove a singular point (lim poly --&gt; 0) for sin(poly)/poly</span>
156        <span class="c">#(Just note: In Python, indentation defines the belongings of &#39;if&#39;, &#39;for&#39;, and so on..)</span>
157        <span class="nb">input</span> <span class="o">=</span> <span class="n">a</span> <span class="o">*</span> <span class="n">x</span> <span class="o">+</span> <span class="n">b</span>
158        <span class="c"># sph_out and _ are in array types from scipy upto n&#39;th order</span>
159        <span class="c"># where _ is not used for this function.</span>
160        <span class="n">sph_out</span><span class="p">,</span> <span class="n">_</span> <span class="o">=</span> <span class="n">scipy</span><span class="o">.</span><span class="n">special</span><span class="o">.</span><span class="n">sph_jn</span><span class="p">(</span><span class="n">n</span><span class="p">,</span> <span class="nb">input</span><span class="p">)</span>
161        <span class="c"># Take only n&#39;th value</span>
162        <span class="n">result</span> <span class="o">=</span> <span class="n">c</span> <span class="o">*</span> <span class="n">sph_out</span><span class="p">[</span><span class="n">n</span><span class="p">]</span> <span class="o">+</span> <span class="n">d</span>      <span class="c">## &lt;-----                </span>
163
164        <span class="k">return</span> <span class="n">result</span> <span class="c">## MODIFY ONLY RESULT. DON&#39;T DELETE RETURN!!!!</span>
165   
166    <span class="c">## DO NOT MODIFY THE FOLLOWING LINES!!!!!!!!!!!!!!!!      </span></div>
167<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.sph_bessel_jn.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>
168        <span class="sd">&quot;&quot;&quot;</span>
169<span class="sd">        Get the model name same as the file name</span>
170<span class="sd">        &quot;&quot;&quot;</span>
171        <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>
172        <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>
173        <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>
174        <span class="k">return</span> <span class="n">name</span>
175           
176<span class="c">###############################################################################   </span>
177<span class="c">## DO NOT MODIFY THE FOLLOWING LINES!!!!!!!!!!!!!!!!       </span></div></div>
178<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> 
179    <span class="n">m</span><span class="o">=</span> <span class="n">Model</span><span class="p">()</span> 
180    <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>
181    <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>
182    <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>
183    <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>
184    <span class="k">print</span> <span class="s">&quot;Testing the value at Q = 0.0:&quot;</span>
185    <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>
186    <span class="k">print</span> <span class="s">&quot;Testing the value at Q = 0.01:&quot;</span>
187    <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>
188    <span class="k">if</span> <span class="n">isfine1</span> <span class="ow">and</span> <span class="n">isfine2</span><span class="p">:</span>
189        <span class="k">print</span> <span class="s">&quot;===&gt; Simple Test: Passed!&quot;</span>
190    <span class="k">else</span><span class="p">:</span>
191        <span class="k">print</span> <span class="s">&quot;===&gt; Simple Test: Failed!&quot;</span>
192</pre></div>
193
194          </div>
195        </div>
196      </div>
197      <div class="sphinxsidebar">
198        <div class="sphinxsidebarwrapper">
199<div id="searchbox" style="display: none">
200  <h3>Quick search</h3>
201    <form class="search" action="../../../../../search.html" method="get">
202      <input type="text" name="q" />
203      <input type="submit" value="Go" />
204      <input type="hidden" name="check_keywords" value="yes" />
205      <input type="hidden" name="area" value="default" />
206    </form>
207    <p class="searchtip" style="font-size: 90%">
208    Enter search terms or a module, class or function name.
209    </p>
210</div>
211<script type="text/javascript">$('#searchbox').show(0);</script>
212        </div>
213      </div>
214      <div class="clearer"></div>
215    </div>
216    <div class="related">
217      <h3>Navigation</h3>
218      <ul>
219        <li class="right" style="margin-right: 10px">
220          <a href="../../../../../genindex.html" title="General Index"
221             >index</a></li>
222        <li class="right" >
223          <a href="../../../../../py-modindex.html" title="Python Module Index"
224             >modules</a> |</li>
225        <li><a href="../../../../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
226          <li><a href="../../../../index.html" >Module code</a> &raquo;</li>
227          <li><a href="../../fitting.html" >sas.perspectives.fitting</a> &raquo;</li> 
228      </ul>
229    </div>
230    <div class="footer">
231        &copy; Copyright 2013, The SasView Project.
232      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
233    </div>
234  </body>
235</html>
Note: See TracBrowser for help on using the repository browser.