source: sasview/_modules/sas/models/GelFitModel.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: 21.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.models.GelFitModel &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.models" href="../models.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="../models.html" accesskey="U">sas.models</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.models.GelFitModel</h1><div class="highlight"><pre>
52<span class="c">##############################################################################</span>
53<span class="c"># This software was developed by the University of Tennessee as part of the</span>
54<span class="c"># Distributed Data Analysis of Neutron Scattering Experiments (DANSE)</span>
55<span class="c"># project funded by the US National Science Foundation.</span>
56<span class="c">#</span>
57<span class="c"># If you use DANSE applications to do scientific research that leads to</span>
58<span class="c"># publication, we ask that you acknowledge the use of the software with the</span>
59<span class="c"># following sentence:</span>
60<span class="c">#</span>
61<span class="c"># This work benefited from DANSE software developed under NSF award DMR-0520547</span>
62<span class="c">#</span>
63<span class="c"># Copyright 2008-2011, University of Tennessee</span>
64<span class="c">##############################################################################</span>
65
66<span class="sd">&quot;&quot;&quot; </span>
67<span class="sd">Provide functionality for a C extension model</span>
68
69<span class="sd">.. WARNING::</span>
70
71<span class="sd">   THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY</span>
72<span class="sd">   DO NOT MODIFY THIS FILE, MODIFY</span>
73<span class="sd">   src/sas/models/include/GelFit.h</span>
74<span class="sd">   AND RE-RUN THE GENERATOR SCRIPT</span>
75<span class="sd">&quot;&quot;&quot;</span>
76
77<span class="kn">from</span> <span class="nn">sas.models.BaseComponent</span> <span class="kn">import</span> <span class="n">BaseComponent</span>
78<span class="kn">from</span> <span class="nn">sas.models.sas_extension.c_models</span> <span class="kn">import</span> <span class="n">CGelFitModel</span>
79
80<div class="viewcode-block" id="create_GelFitModel"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.GelFitModel.create_GelFitModel">[docs]</a><span class="k">def</span> <span class="nf">create_GelFitModel</span><span class="p">():</span>
81    <span class="sd">&quot;&quot;&quot;</span>
82<span class="sd">       Create a model instance</span>
83<span class="sd">    &quot;&quot;&quot;</span>
84    <span class="n">obj</span> <span class="o">=</span> <span class="n">GelFitModel</span><span class="p">()</span>
85    <span class="c"># CGelFitModel.__init__(obj) is called by</span>
86    <span class="c"># the GelFitModel constructor</span>
87    <span class="k">return</span> <span class="n">obj</span>
88</div>
89<div class="viewcode-block" id="GelFitModel"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.GelFitModel.GelFitModel">[docs]</a><span class="k">class</span> <span class="nc">GelFitModel</span><span class="p">(</span><span class="n">CGelFitModel</span><span class="p">,</span> <span class="n">BaseComponent</span><span class="p">):</span>
90    <span class="sd">&quot;&quot;&quot; </span>
91<span class="sd">    Class that evaluates a GelFitModel model. </span>
92<span class="sd">    This file was auto-generated from src/sas/models/include/GelFit.h.</span>
93<span class="sd">    Refer to that file and the structure it contains</span>
94<span class="sd">    for details of the model.</span>
95<span class="sd">    </span>
96<span class="sd">    List of default parameters:</span>
97
98<span class="sd">    * lScale          = 3.5 </span>
99<span class="sd">    * gScale          = 1.7 </span>
100<span class="sd">    * zeta            = 16.0 </span>
101<span class="sd">    * radius          = 104.0 </span>
102<span class="sd">    * scale           = 2.0 </span>
103<span class="sd">    * background      = 0.01 </span>
104
105<span class="sd">    &quot;&quot;&quot;</span>
106       
107    <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">multfactor</span><span class="o">=</span><span class="mi">1</span><span class="p">):</span>
108        <span class="sd">&quot;&quot;&quot; Initialization &quot;&quot;&quot;</span>
109        <span class="bp">self</span><span class="o">.</span><span class="n">__dict__</span> <span class="o">=</span> <span class="p">{}</span>
110       
111        <span class="c"># Initialize BaseComponent first, then sphere</span>
112        <span class="n">BaseComponent</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
113        <span class="c">#apply(CGelFitModel.__init__, (self,)) </span>
114
115        <span class="n">CGelFitModel</span><span class="o">.</span><span class="n">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
116        <span class="bp">self</span><span class="o">.</span><span class="n">is_multifunc</span> <span class="o">=</span> <span class="bp">False</span>
117                       
118        <span class="c">## Name of the model</span>
119        <span class="bp">self</span><span class="o">.</span><span class="n">name</span> <span class="o">=</span> <span class="s">&quot;GelFitModel&quot;</span>
120        <span class="c">## Model description</span>
121        <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>
122<span class="s">        Structure factor for interacting particles:                   .</span>
123<span class="s">                Shibayama-Geissler Two-Length Scale Fit for Gels</span>
124<span class="s">                (GelFit)</span>
125<span class="s">                </span>
126<span class="s">                Sibayama; Tanaka; Han J Chem Phys(1992), 97(9), 6829-6841</span>
127<span class="s">                Mallam; Horkay; Hecht; Rennie; Geissler, Macromol(1991), 24, 543</span>
128<span class="s">        &quot;&quot;&quot;</span>
129       
130        <span class="c">## Parameter details [units, min, max]</span>
131        <span class="bp">self</span><span class="o">.</span><span class="n">details</span> <span class="o">=</span> <span class="p">{}</span>
132        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;lScale&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
133        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;gScale&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
134        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;zeta&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
135        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;radius&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
136        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;scale&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
137        <span class="bp">self</span><span class="o">.</span><span class="n">details</span><span class="p">[</span><span class="s">&#39;background&#39;</span><span class="p">]</span> <span class="o">=</span> <span class="p">[</span><span class="s">&#39;&#39;</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">]</span>
138
139        <span class="c">## fittable parameters</span>
140        <span class="bp">self</span><span class="o">.</span><span class="n">fixed</span> <span class="o">=</span> <span class="p">[]</span>
141       
142        <span class="c">## non-fittable parameters</span>
143        <span class="bp">self</span><span class="o">.</span><span class="n">non_fittable</span> <span class="o">=</span> <span class="p">[]</span>
144       
145        <span class="c">## parameters with orientation</span>
146        <span class="bp">self</span><span class="o">.</span><span class="n">orientation_params</span> <span class="o">=</span> <span class="p">[]</span>
147
148        <span class="c">## parameters with magnetism</span>
149        <span class="bp">self</span><span class="o">.</span><span class="n">magnetic_params</span> <span class="o">=</span> <span class="p">[]</span>
150
151        <span class="bp">self</span><span class="o">.</span><span class="n">category</span> <span class="o">=</span> <span class="bp">None</span>
152        <span class="bp">self</span><span class="o">.</span><span class="n">multiplicity_info</span> <span class="o">=</span> <span class="bp">None</span>
153       
154    <span class="k">def</span> <span class="nf">__setstate__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">state</span><span class="p">):</span>
155        <span class="sd">&quot;&quot;&quot;</span>
156<span class="sd">        restore the state of a model from pickle</span>
157<span class="sd">        &quot;&quot;&quot;</span>
158        <span class="bp">self</span><span class="o">.</span><span class="n">__dict__</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="bp">self</span><span class="o">.</span><span class="n">dispersion</span> <span class="o">=</span> <span class="n">state</span>
159       
160    <span class="k">def</span> <span class="nf">__reduce_ex__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">proto</span><span class="p">):</span>
161        <span class="sd">&quot;&quot;&quot;</span>
162<span class="sd">        Overwrite the __reduce_ex__ of PyTypeObject *type call in the init of </span>
163<span class="sd">        c model.</span>
164<span class="sd">        &quot;&quot;&quot;</span>
165        <span class="n">state</span> <span class="o">=</span> <span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__dict__</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="bp">self</span><span class="o">.</span><span class="n">dispersion</span><span class="p">)</span>
166        <span class="k">return</span> <span class="p">(</span><span class="n">create_GelFitModel</span><span class="p">,</span> <span class="nb">tuple</span><span class="p">(),</span> <span class="n">state</span><span class="p">,</span> <span class="bp">None</span><span class="p">,</span> <span class="bp">None</span><span class="p">)</span>
167       
168<div class="viewcode-block" id="GelFitModel.clone"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.GelFitModel.GelFitModel.clone">[docs]</a>    <span class="k">def</span> <span class="nf">clone</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
169        <span class="sd">&quot;&quot;&quot; Return a identical copy of self &quot;&quot;&quot;</span>
170        <span class="k">return</span> <span class="bp">self</span><span class="o">.</span><span class="n">_clone</span><span class="p">(</span><span class="n">GelFitModel</span><span class="p">())</span>   
171        </div>
172<div class="viewcode-block" id="GelFitModel.run"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.GelFitModel.GelFitModel.run">[docs]</a>    <span class="k">def</span> <span class="nf">run</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>
173        <span class="sd">&quot;&quot;&quot; </span>
174<span class="sd">        Evaluate the model</span>
175<span class="sd">        </span>
176<span class="sd">        :param x: input q, or [q,phi]</span>
177<span class="sd">        </span>
178<span class="sd">        :return: scattering function P(q)</span>
179<span class="sd">        </span>
180<span class="sd">        &quot;&quot;&quot;</span>
181        <span class="k">return</span> <span class="n">CGelFitModel</span><span class="o">.</span><span class="n">run</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">)</span>
182   </div>
183<div class="viewcode-block" id="GelFitModel.runXY"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.GelFitModel.GelFitModel.runXY">[docs]</a>    <span class="k">def</span> <span class="nf">runXY</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>
184        <span class="sd">&quot;&quot;&quot; </span>
185<span class="sd">        Evaluate the model in cartesian coordinates</span>
186<span class="sd">        </span>
187<span class="sd">        :param x: input q, or [qx, qy]</span>
188<span class="sd">        </span>
189<span class="sd">        :return: scattering function P(q)</span>
190<span class="sd">        </span>
191<span class="sd">        &quot;&quot;&quot;</span>
192        <span class="k">return</span> <span class="n">CGelFitModel</span><span class="o">.</span><span class="n">runXY</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">)</span>
193        </div>
194<div class="viewcode-block" id="GelFitModel.evalDistribution"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.GelFitModel.GelFitModel.evalDistribution">[docs]</a>    <span class="k">def</span> <span class="nf">evalDistribution</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">):</span>
195        <span class="sd">&quot;&quot;&quot; </span>
196<span class="sd">        Evaluate the model in cartesian coordinates</span>
197<span class="sd">        </span>
198<span class="sd">        :param x: input q[], or [qx[], qy[]]</span>
199<span class="sd">        </span>
200<span class="sd">        :return: scattering function P(q[])</span>
201<span class="sd">        </span>
202<span class="sd">        &quot;&quot;&quot;</span>
203        <span class="k">return</span> <span class="n">CGelFitModel</span><span class="o">.</span><span class="n">evalDistribution</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">x</span><span class="p">)</span>
204        </div>
205<div class="viewcode-block" id="GelFitModel.calculate_ER"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.GelFitModel.GelFitModel.calculate_ER">[docs]</a>    <span class="k">def</span> <span class="nf">calculate_ER</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
206        <span class="sd">&quot;&quot;&quot; </span>
207<span class="sd">        Calculate the effective radius for P(q)*S(q)</span>
208<span class="sd">        </span>
209<span class="sd">        :return: the value of the effective radius</span>
210<span class="sd">        </span>
211<span class="sd">        &quot;&quot;&quot;</span>       
212        <span class="k">return</span> <span class="n">CGelFitModel</span><span class="o">.</span><span class="n">calculate_ER</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
213        </div>
214<div class="viewcode-block" id="GelFitModel.calculate_VR"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.GelFitModel.GelFitModel.calculate_VR">[docs]</a>    <span class="k">def</span> <span class="nf">calculate_VR</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
215        <span class="sd">&quot;&quot;&quot; </span>
216<span class="sd">        Calculate the volf ratio for P(q)*S(q)</span>
217<span class="sd">        </span>
218<span class="sd">        :return: the value of the volf ratio</span>
219<span class="sd">        </span>
220<span class="sd">        &quot;&quot;&quot;</span>       
221        <span class="k">return</span> <span class="n">CGelFitModel</span><span class="o">.</span><span class="n">calculate_VR</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span>
222              </div>
223<div class="viewcode-block" id="GelFitModel.set_dispersion"><a class="viewcode-back" href="../../../dev/api/sas.models.html#sas.models.GelFitModel.GelFitModel.set_dispersion">[docs]</a>    <span class="k">def</span> <span class="nf">set_dispersion</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">parameter</span><span class="p">,</span> <span class="n">dispersion</span><span class="p">):</span>
224        <span class="sd">&quot;&quot;&quot;</span>
225<span class="sd">        Set the dispersion object for a model parameter</span>
226<span class="sd">        </span>
227<span class="sd">        :param parameter: name of the parameter [string]</span>
228<span class="sd">        :param dispersion: dispersion object of type DispersionModel</span>
229<span class="sd">        </span>
230<span class="sd">        &quot;&quot;&quot;</span>
231        <span class="k">return</span> <span class="n">CGelFitModel</span><span class="o">.</span><span class="n">set_dispersion</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span>
232               <span class="n">parameter</span><span class="p">,</span> <span class="n">dispersion</span><span class="o">.</span><span class="n">cdisp</span><span class="p">)</span>
233       
234   
235<span class="c"># End of file</span>
236</pre></div></div></div>
237
238          </div>
239        </div>
240      </div>
241      <div class="sphinxsidebar">
242        <div class="sphinxsidebarwrapper">
243<div id="searchbox" style="display: none">
244  <h3>Quick search</h3>
245    <form class="search" action="../../../search.html" method="get">
246      <input type="text" name="q" />
247      <input type="submit" value="Go" />
248      <input type="hidden" name="check_keywords" value="yes" />
249      <input type="hidden" name="area" value="default" />
250    </form>
251    <p class="searchtip" style="font-size: 90%">
252    Enter search terms or a module, class or function name.
253    </p>
254</div>
255<script type="text/javascript">$('#searchbox').show(0);</script>
256        </div>
257      </div>
258      <div class="clearer"></div>
259    </div>
260    <div class="related">
261      <h3>Navigation</h3>
262      <ul>
263        <li class="right" style="margin-right: 10px">
264          <a href="../../../genindex.html" title="General Index"
265             >index</a></li>
266        <li class="right" >
267          <a href="../../../py-modindex.html" title="Python Module Index"
268             >modules</a> |</li>
269        <li><a href="../../../index.html">SasView 3.0.0 documentation</a> &raquo;</li>
270          <li><a href="../../index.html" >Module code</a> &raquo;</li>
271          <li><a href="../models.html" >sas.models</a> &raquo;</li> 
272      </ul>
273    </div>
274    <div class="footer">
275        &copy; Copyright 2013, The SasView Project.
276      Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.3.
277    </div>
278  </body>
279</html>
Note: See TracBrowser for help on using the repository browser.