source: sasview/sansmodels/docs/sphinx/html/api/RPAModel.html @ fafdfd3

ESS_GUIESS_GUI_DocsESS_GUI_batch_fittingESS_GUI_bumps_abstractionESS_GUI_iss1116ESS_GUI_iss879ESS_GUI_iss959ESS_GUI_openclESS_GUI_orderingESS_GUI_sync_sascalccostrafo411magnetic_scattrelease-4.1.1release-4.1.2release-4.2.2release_4.0.1ticket-1009ticket-1094-headlessticket-1242-2d-resolutionticket-1243ticket-1249ticket885unittest-saveload
Last change on this file since fafdfd3 was 512573a, checked in by Jessica Tumarkin <jtumarki@…>, 13 years ago

HTML folder generated by Sphinx
  • Property mode set to 100644
File size: 15.9 KB
Line 
1
2
3<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5
6<html xmlns="http://www.w3.org/1999/xhtml">
7  <head>
8    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9   
10    <title>RPAModel &mdash; sansmodels v0.1.0 documentation</title>
11    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
12    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13    <script type="text/javascript">
14      var DOCUMENTATION_OPTIONS = {
15        URL_ROOT:    '../',
16        VERSION:     '0.1.0',
17        COLLAPSE_INDEX: false,
18        FILE_SUFFIX: '.html',
19        HAS_SOURCE:  true
20      };
21    </script>
22    <script type="text/javascript" src="../_static/jquery.js"></script>
23    <script type="text/javascript" src="../_static/underscore.js"></script>
24    <script type="text/javascript" src="../_static/doctools.js"></script>
25    <link rel="top" title="sansmodels v0.1.0 documentation" href="../index.html" />
26    <link rel="up" title="Reference" href="index.html" />
27    <link rel="next" title="SCCrystalModel" href="SCCrystalModel.html" />
28    <link rel="prev" title="RPA10Model" href="RPA10Model.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 class="right" >
41          <a href="SCCrystalModel.html" title="SCCrystalModel"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="RPA10Model.html" title="RPA10Model"
45             accesskey="P">previous</a> |</li>
46        <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li>
47          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li> 
48      </ul>
49    </div> 
50
51    <div class="document">
52      <div class="documentwrapper">
53        <div class="bodywrapper">
54          <div class="body">
55           
56  <div class="section" id="rpamodel">
57<h1>RPAModel<a class="headerlink" href="#rpamodel" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.models.RPAModel">
59<span id="sans-models-rpamodel"></span><h2><a class="reference internal" href="#module-sans.models.RPAModel" title="sans.models.RPAModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.RPAModel</span></tt></a><a class="headerlink" href="#module-sans.models.RPAModel" title="Permalink to this headline">¶</a></h2>
60<p>Provide functionality for a C extension model</p>
61<table class="docutils field-list" frame="void" rules="none">
62<col class="field-name" />
63<col class="field-body" />
64<tbody valign="top">
65<tr class="field"><th class="field-name">WARNING:</th><td class="field-body">THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY
66DO NOT MODIFY THIS FILE, MODIFY ..c_extensions</td>
67</tr>
68</tbody>
69</table>
70<dl class="docutils">
71<dt>pa.h</dt>
72<dd>AND RE-RUN THE GENERATOR SCRIPT</dd>
73</dl>
74<dl class="class">
75<dt id="sans.models.RPAModel.RPAModel">
76<em class="property">class </em><tt class="descclassname">sans.models.RPAModel.</tt><tt class="descname">RPAModel</tt><a class="headerlink" href="#sans.models.RPAModel.RPAModel" title="Permalink to this definition">¶</a></dt>
77<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">CRPAModel</span></tt>, <a class="reference internal" href="BaseComponent.html#sans.models.BaseComponent.BaseComponent" title="sans.models.BaseComponent.BaseComponent"><tt class="xref py py-class docutils literal"><span class="pre">sans.models.BaseComponent.BaseComponent</span></tt></a></p>
78<blockquote>
79<div>Class that evaluates a RPAModel model.
80This file was auto-generated from ..c_extensions</div></blockquote>
81<dl class="docutils">
82<dt>pa.h.</dt>
83<dd><p class="first">Refer to that file and the structure it contains
84for details of the model.
85List of default parameters:</p>
86<blockquote class="last">
87<div>lcase_n         = 0.0
88ba              = 5.0
89bb              = 5.0
90bc              = 5.0
91bd              = 5.0
92Kab             = -0.0004
93Kac             = -0.0004
94Kad             = -0.0004
95Kbc             = -0.0004
96Kbd             = -0.0004
97Kcd             = -0.0004
98scale           = 1.0
99background      = 0.0 [1/cm]
100Na              = 1000.0
101Phia            = 0.25
102va              = 100.0
103La              = 1e-12
104Nb              = 1000.0
105Phib            = 0.25
106vb              = 100.0
107Lb              = 1e-12
108Nc              = 1000.0
109Phic            = 0.25
110vc              = 100.0
111Lc              = 1e-12
112Nd              = 1000.0
113Phid            = 0.25
114vd              = 100.0
115Ld              = 0.0</div></blockquote>
116</dd>
117</dl>
118<dl class="method">
119<dt id="sans.models.RPAModel.RPAModel.calculate_ER">
120<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.RPAModel.RPAModel.calculate_ER" title="Permalink to this definition">¶</a></dt>
121<dd><p>Calculate the effective radius for P(q)*S(q)</p>
122<table class="docutils field-list" frame="void" rules="none">
123<col class="field-name" />
124<col class="field-body" />
125<tbody valign="top">
126<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td>
127</tr>
128</tbody>
129</table>
130</dd></dl>
131
132<dl class="method">
133<dt id="sans.models.RPAModel.RPAModel.clone">
134<tt class="descname">clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.RPAModel.RPAModel.clone" title="Permalink to this definition">¶</a></dt>
135<dd><p>Return a identical copy of self</p>
136</dd></dl>
137
138<dl class="attribute">
139<dt id="sans.models.RPAModel.RPAModel.dispersion">
140<tt class="descname">dispersion</tt><a class="headerlink" href="#sans.models.RPAModel.RPAModel.dispersion" title="Permalink to this definition">¶</a></dt>
141<dd><p>Dispersion parameters</p>
142</dd></dl>
143
144<dl class="method">
145<dt id="sans.models.RPAModel.RPAModel.evalDistribution">
146<tt class="descname">evalDistribution</tt><big>(</big><em>x=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.models.RPAModel.RPAModel.evalDistribution" title="Permalink to this definition">¶</a></dt>
147<dd><p>Evaluate the model in cartesian coordinates</p>
148<table class="docutils field-list" frame="void" rules="none">
149<col class="field-name" />
150<col class="field-body" />
151<tbody valign="top">
152<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q[], or [qx[], qy[]]</td>
153</tr>
154<tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td>
155</tr>
156</tbody>
157</table>
158</dd></dl>
159
160<dl class="method">
161<dt id="sans.models.RPAModel.RPAModel.getDispParamList">
162<tt class="descname">getDispParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.RPAModel.RPAModel.getDispParamList" title="Permalink to this definition">¶</a></dt>
163<dd><p>Return a list of all available parameters for the model</p>
164</dd></dl>
165
166<dl class="method">
167<dt id="sans.models.RPAModel.RPAModel.getParam">
168<tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.RPAModel.RPAModel.getParam" title="Permalink to this definition">¶</a></dt>
169<dd><p>Set the value of a model parameter</p>
170<table class="docutils field-list" frame="void" rules="none">
171<col class="field-name" />
172<col class="field-body" />
173<tbody valign="top">
174<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td>
175</tr>
176</tbody>
177</table>
178</dd></dl>
179
180<dl class="method">
181<dt id="sans.models.RPAModel.RPAModel.getParamList">
182<tt class="descname">getParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.RPAModel.RPAModel.getParamList" title="Permalink to this definition">¶</a></dt>
183<dd><p>Return a list of all available parameters for the model</p>
184</dd></dl>
185
186<dl class="method">
187<dt id="sans.models.RPAModel.RPAModel.getParamListWithToken">
188<tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.RPAModel.RPAModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt>
189<dd></dd></dl>
190
191<dl class="method">
192<dt id="sans.models.RPAModel.RPAModel.getParamWithToken">
193<tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.RPAModel.RPAModel.getParamWithToken" title="Permalink to this definition">¶</a></dt>
194<dd></dd></dl>
195
196<dl class="method">
197<dt id="sans.models.RPAModel.RPAModel.is_fittable">
198<tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.RPAModel.RPAModel.is_fittable" title="Permalink to this definition">¶</a></dt>
199<dd><p>Check if a given parameter is fittable or not</p>
200<table class="docutils field-list" frame="void" rules="none">
201<col class="field-name" />
202<col class="field-body" />
203<tbody valign="top">
204<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td>
205</tr>
206</tbody>
207</table>
208</dd></dl>
209
210<dl class="attribute">
211<dt id="sans.models.RPAModel.RPAModel.log">
212<tt class="descname">log</tt><a class="headerlink" href="#sans.models.RPAModel.RPAModel.log" title="Permalink to this definition">¶</a></dt>
213<dd><p>Log</p>
214</dd></dl>
215
216<dl class="attribute">
217<dt id="sans.models.RPAModel.RPAModel.params">
218<tt class="descname">params</tt><a class="headerlink" href="#sans.models.RPAModel.RPAModel.params" title="Permalink to this definition">¶</a></dt>
219<dd><p>Parameters</p>
220</dd></dl>
221
222<dl class="attribute">
223<dt id="sans.models.RPAModel.RPAModel.reset">
224<tt class="descname">reset</tt><a class="headerlink" href="#sans.models.RPAModel.RPAModel.reset" title="Permalink to this definition">¶</a></dt>
225<dd><p>Reset pair correlation</p>
226</dd></dl>
227
228<dl class="method">
229<dt id="sans.models.RPAModel.RPAModel.run">
230<tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.RPAModel.RPAModel.run" title="Permalink to this definition">¶</a></dt>
231<dd><p>Evaluate the model</p>
232<table class="docutils field-list" frame="void" rules="none">
233<col class="field-name" />
234<col class="field-body" />
235<tbody valign="top">
236<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [q,phi]</td>
237</tr>
238<tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
239</tr>
240</tbody>
241</table>
242</dd></dl>
243
244<dl class="method">
245<dt id="sans.models.RPAModel.RPAModel.runXY">
246<tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.RPAModel.RPAModel.runXY" title="Permalink to this definition">¶</a></dt>
247<dd><p>Evaluate the model in cartesian coordinates</p>
248<table class="docutils field-list" frame="void" rules="none">
249<col class="field-name" />
250<col class="field-body" />
251<tbody valign="top">
252<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [qx, qy]</td>
253</tr>
254<tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
255</tr>
256</tbody>
257</table>
258</dd></dl>
259
260<dl class="method">
261<dt id="sans.models.RPAModel.RPAModel.setParam">
262<tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.RPAModel.RPAModel.setParam" title="Permalink to this definition">¶</a></dt>
263<dd><p>Set the value of a model parameter</p>
264<table class="docutils field-list" frame="void" rules="none">
265<col class="field-name" />
266<col class="field-body" />
267<tbody valign="top">
268<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
269<li><strong>name</strong> &#8211; name of the parameter</li>
270<li><strong>value</strong> &#8211; value of the parameter</li>
271</ul>
272</td>
273</tr>
274</tbody>
275</table>
276</dd></dl>
277
278<dl class="method">
279<dt id="sans.models.RPAModel.RPAModel.setParamWithToken">
280<tt class="descname">setParamWithToken</tt><big>(</big><em>name</em>, <em>value</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.RPAModel.RPAModel.setParamWithToken" title="Permalink to this definition">¶</a></dt>
281<dd></dd></dl>
282
283<dl class="method">
284<dt id="sans.models.RPAModel.RPAModel.set_dispersion">
285<tt class="descname">set_dispersion</tt><big>(</big><em>parameter</em>, <em>dispersion</em><big>)</big><a class="headerlink" href="#sans.models.RPAModel.RPAModel.set_dispersion" title="Permalink to this definition">¶</a></dt>
286<dd><p>Set the dispersion object for a model parameter</p>
287<table class="docutils field-list" frame="void" rules="none">
288<col class="field-name" />
289<col class="field-body" />
290<tbody valign="top">
291<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
292<li><strong>parameter</strong> &#8211; name of the parameter [string]</li>
293<li><strong>dispersion</strong> &#8211; dispersion object of type DispersionModel</li>
294</ul>
295</td>
296</tr>
297</tbody>
298</table>
299</dd></dl>
300
301</dd></dl>
302
303<dl class="function">
304<dt id="sans.models.RPAModel.create_RPAModel">
305<tt class="descclassname">sans.models.RPAModel.</tt><tt class="descname">create_RPAModel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.RPAModel.create_RPAModel" title="Permalink to this definition">¶</a></dt>
306<dd></dd></dl>
307
308</div>
309</div>
310
311
312          </div>
313        </div>
314      </div>
315      <div class="sphinxsidebar">
316        <div class="sphinxsidebarwrapper">
317  <h3><a href="../index.html">Table Of Contents</a></h3>
318  <ul>
319<li><a class="reference internal" href="#">RPAModel</a><ul>
320<li><a class="reference internal" href="#module-sans.models.RPAModel"><tt class="docutils literal"><span class="pre">sans.models.RPAModel</span></tt></a></li>
321</ul>
322</li>
323</ul>
324
325  <h4>Previous topic</h4>
326  <p class="topless"><a href="RPA10Model.html"
327                        title="previous chapter">RPA10Model</a></p>
328  <h4>Next topic</h4>
329  <p class="topless"><a href="SCCrystalModel.html"
330                        title="next chapter">SCCrystalModel</a></p>
331  <h3>This Page</h3>
332  <ul class="this-page-menu">
333    <li><a href="../_sources/api/RPAModel.txt"
334           rel="nofollow">Show Source</a></li>
335  </ul>
336<div id="searchbox" style="display: none">
337  <h3>Quick search</h3>
338    <form class="search" action="../search.html" method="get">
339      <input type="text" name="q" size="18" />
340      <input type="submit" value="Go" />
341      <input type="hidden" name="check_keywords" value="yes" />
342      <input type="hidden" name="area" value="default" />
343    </form>
344    <p class="searchtip" style="font-size: 90%">
345    Enter search terms or a module, class or function name.
346    </p>
347</div>
348<script type="text/javascript">$('#searchbox').show(0);</script>
349        </div>
350      </div>
351      <div class="clearer"></div>
352    </div>
353    <div class="related">
354      <h3>Navigation</h3>
355      <ul>
356        <li class="right" style="margin-right: 10px">
357          <a href="../genindex.html" title="General Index"
358             >index</a></li>
359        <li class="right" >
360          <a href="../py-modindex.html" title="Python Module Index"
361             >modules</a> |</li>
362        <li class="right" >
363          <a href="SCCrystalModel.html" title="SCCrystalModel"
364             >next</a> |</li>
365        <li class="right" >
366          <a href="RPA10Model.html" title="RPA10Model"
367             >previous</a> |</li>
368        <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li>
369          <li><a href="index.html" >Reference</a> &raquo;</li> 
370      </ul>
371    </div>
372    <div class="footer">
373        &copy; Copyright 2010, sans group.
374      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
375    </div>
376  </body>
377</html>
Note: See TracBrowser for help on using the repository browser.