source: sasview/sansmodels/docs/sphinx/html/api/RPA10Model.html @ 01de557

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 01de557 was c0d873f, checked in by Gervaise Alina <gervyh@…>, 13 years ago

edit docs for models
  • Property mode set to 100644
File size: 16.2 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
7<html xmlns="http://www.w3.org/1999/xhtml">
8  <head>
9    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10   
11    <title>RPA10Model &mdash; sansmodels 0.1.0 documentation</title>
12   
13    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
14    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
15   
16    <script type="text/javascript">
17      var DOCUMENTATION_OPTIONS = {
18        URL_ROOT:    '../',
19        VERSION:     '0.1.0',
20        COLLAPSE_INDEX: false,
21        FILE_SUFFIX: '.html',
22        HAS_SOURCE:  true
23      };
24    </script>
25    <script type="text/javascript" src="../_static/jquery.js"></script>
26    <script type="text/javascript" src="../_static/underscore.js"></script>
27    <script type="text/javascript" src="../_static/doctools.js"></script>
28    <link rel="top" title="sansmodels 0.1.0 documentation" href="../index.html" />
29    <link rel="up" title="Reference" href="index.html" />
30    <link rel="next" title="RPAModel" href="RPAModel.html" />
31    <link rel="prev" title="ReflModel" href="ReflModel.html" /> 
32  </head>
33  <body>
34    <div class="related">
35      <h3>Navigation</h3>
36      <ul>
37        <li class="right" style="margin-right: 10px">
38          <a href="../genindex.html" title="General Index"
39             accesskey="I">index</a></li>
40        <li class="right" >
41          <a href="../py-modindex.html" title="Python Module Index"
42             >modules</a> |</li>
43        <li class="right" >
44          <a href="RPAModel.html" title="RPAModel"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="ReflModel.html" title="ReflModel"
48             accesskey="P">previous</a> |</li>
49        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li>
50          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li> 
51      </ul>
52    </div> 
53
54    <div class="document">
55      <div class="documentwrapper">
56        <div class="bodywrapper">
57          <div class="body">
58           
59  <div class="section" id="rpa10model">
60<h1>RPA10Model<a class="headerlink" href="#rpa10model" title="Permalink to this headline">¶</a></h1>
61<div class="section" id="sans-models-rpa10model">
62<h2><a class="reference internal" href="#module-sans.models.RPA10Model" title="sans.models.RPA10Model"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.RPA10Model</span></tt></a><a class="headerlink" href="#sans-models-rpa10model" title="Permalink to this headline">¶</a></h2>
63<span class="target" id="module-sans.models.RPA10Model"></span><dl class="class">
64<dt id="sans.models.RPA10Model.RPA10Model">
65<em class="property">class </em><tt class="descclassname">sans.models.RPA10Model.</tt><tt class="descname">RPA10Model</tt><a class="headerlink" href="#sans.models.RPA10Model.RPA10Model" title="Permalink to this definition">¶</a></dt>
66<dd><p>Bases: <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>
67<p>This multi-model is based on Parratt formalism and provides the capability
68of changing the number of layers between 0 and 10.</p>
69<dl class="method">
70<dt id="sans.models.RPA10Model.RPA10Model.__add__">
71<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.RPA10Model.RPA10Model.__add__" title="Permalink to this definition">¶</a></dt>
72<dd></dd></dl>
73
74<dl class="method">
75<dt id="sans.models.RPA10Model.RPA10Model.__div__">
76<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.RPA10Model.RPA10Model.__div__" title="Permalink to this definition">¶</a></dt>
77<dd></dd></dl>
78
79<dl class="method">
80<dt id="sans.models.RPA10Model.RPA10Model.__init__">
81<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.RPA10Model.RPA10Model.__init__" title="Permalink to this definition">¶</a></dt>
82<dd></dd></dl>
83
84<dl class="attribute">
85<dt id="sans.models.RPA10Model.RPA10Model.__module__">
86<tt class="descname">__module__</tt><em class="property"> = 'sans.models.RPA10Model'</em><a class="headerlink" href="#sans.models.RPA10Model.RPA10Model.__module__" title="Permalink to this definition">¶</a></dt>
87<dd></dd></dl>
88
89<dl class="method">
90<dt id="sans.models.RPA10Model.RPA10Model.__mul__">
91<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.RPA10Model.RPA10Model.__mul__" title="Permalink to this definition">¶</a></dt>
92<dd></dd></dl>
93
94<dl class="method">
95<dt id="sans.models.RPA10Model.RPA10Model.__str__">
96<tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.RPA10Model.RPA10Model.__str__" title="Permalink to this definition">¶</a></dt>
97<dd><table class="docutils field-list" frame="void" rules="none">
98<col class="field-name" />
99<col class="field-body" />
100<tbody valign="top">
101<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">string representatio</td>
102</tr>
103</tbody>
104</table>
105</dd></dl>
106
107<dl class="method">
108<dt id="sans.models.RPA10Model.RPA10Model.__sub__">
109<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.RPA10Model.RPA10Model.__sub__" title="Permalink to this definition">¶</a></dt>
110<dd></dd></dl>
111
112<dl class="method">
113<dt id="sans.models.RPA10Model.RPA10Model._clone">
114<tt class="descname">_clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.RPA10Model.RPA10Model._clone" title="Permalink to this definition">¶</a></dt>
115<dd><p>Internal utility function to copy the internal
116data members to a fresh copy.</p>
117</dd></dl>
118
119<dl class="method">
120<dt id="sans.models.RPA10Model.RPA10Model._get_func_list">
121<tt class="descname">_get_func_list</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.RPA10Model.RPA10Model._get_func_list" title="Permalink to this definition">¶</a></dt>
122<dd><p>Get the list of functions in each cases</p>
123</dd></dl>
124
125<dl class="method">
126<dt id="sans.models.RPA10Model.RPA10Model._setParamHelper">
127<tt class="descname">_setParamHelper</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.RPA10Model.RPA10Model._setParamHelper" title="Permalink to this definition">¶</a></dt>
128<dd><p>Helper function to setParam</p>
129</dd></dl>
130
131<dl class="method">
132<dt id="sans.models.RPA10Model.RPA10Model._set_details">
133<tt class="descname">_set_details</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.RPA10Model.RPA10Model._set_details" title="Permalink to this definition">¶</a></dt>
134<dd><p>Concatenate details of the original model to create
135this model details</p>
136</dd></dl>
137
138<dl class="method">
139<dt id="sans.models.RPA10Model.RPA10Model._set_dispersion">
140<tt class="descname">_set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.RPA10Model.RPA10Model._set_dispersion" title="Permalink to this definition">¶</a></dt>
141<dd><p>model dispersions</p>
142</dd></dl>
143
144<dl class="method">
145<dt id="sans.models.RPA10Model.RPA10Model._set_fixed_params">
146<tt class="descname">_set_fixed_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.RPA10Model.RPA10Model._set_fixed_params" title="Permalink to this definition">¶</a></dt>
147<dd><p>Fill the self.fixed list with the model fixed list</p>
148</dd></dl>
149
150<dl class="method">
151<dt id="sans.models.RPA10Model.RPA10Model._set_params">
152<tt class="descname">_set_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.RPA10Model.RPA10Model._set_params" title="Permalink to this definition">¶</a></dt>
153<dd><p>Concatenate the parameters of the model to create
154this model parameters</p>
155</dd></dl>
156
157<dl class="method">
158<dt id="sans.models.RPA10Model.RPA10Model.calculate_ER">
159<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.RPA10Model.RPA10Model.calculate_ER" title="Permalink to this definition">¶</a></dt>
160<dd></dd></dl>
161
162<dl class="method">
163<dt id="sans.models.RPA10Model.RPA10Model.clone">
164<tt class="descname">clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.RPA10Model.RPA10Model.clone" title="Permalink to this definition">¶</a></dt>
165<dd><p>Returns a new object identical to the current object</p>
166</dd></dl>
167
168<dl class="method">
169<dt id="sans.models.RPA10Model.RPA10Model.evalDistribution">
170<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.RPA10Model.RPA10Model.evalDistribution" title="Permalink to this definition">¶</a></dt>
171<dd><p>Evaluate the model in cartesian coordinates</p>
172<p>: param x: input q[], or [qx[], qy[]]
173: return: scattering function P(q[])</p>
174</dd></dl>
175
176<dl class="method">
177<dt id="sans.models.RPA10Model.RPA10Model.getDispParamList">
178<tt class="descname">getDispParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.RPA10Model.RPA10Model.getDispParamList" title="Permalink to this definition">¶</a></dt>
179<dd><p>Return a list of all available parameters for the model</p>
180</dd></dl>
181
182<dl class="method">
183<dt id="sans.models.RPA10Model.RPA10Model.getParam">
184<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.RPA10Model.RPA10Model.getParam" title="Permalink to this definition">¶</a></dt>
185<dd><p>Set the value of a model parameter</p>
186<table class="docutils field-list" frame="void" rules="none">
187<col class="field-name" />
188<col class="field-body" />
189<tbody valign="top">
190<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td>
191</tr>
192</tbody>
193</table>
194</dd></dl>
195
196<dl class="method">
197<dt id="sans.models.RPA10Model.RPA10Model.getParamList">
198<tt class="descname">getParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.RPA10Model.RPA10Model.getParamList" title="Permalink to this definition">¶</a></dt>
199<dd><p>Return a list of all available parameters for the model</p>
200</dd></dl>
201
202<dl class="method">
203<dt id="sans.models.RPA10Model.RPA10Model.getParamListWithToken">
204<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.RPA10Model.RPA10Model.getParamListWithToken" title="Permalink to this definition">¶</a></dt>
205<dd></dd></dl>
206
207<dl class="method">
208<dt id="sans.models.RPA10Model.RPA10Model.getParamWithToken">
209<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.RPA10Model.RPA10Model.getParamWithToken" title="Permalink to this definition">¶</a></dt>
210<dd></dd></dl>
211
212<dl class="method">
213<dt id="sans.models.RPA10Model.RPA10Model.getProfile">
214<tt class="descname">getProfile</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.RPA10Model.RPA10Model.getProfile" title="Permalink to this definition">¶</a></dt>
215<dd><p>Get SLD profile</p>
216<p>: return: None, No SLD profile supporting for this model</p>
217</dd></dl>
218
219<dl class="method">
220<dt id="sans.models.RPA10Model.RPA10Model.is_fittable">
221<tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.RPA10Model.RPA10Model.is_fittable" title="Permalink to this definition">¶</a></dt>
222<dd><p>Check if a given parameter is fittable or not</p>
223<table class="docutils field-list" frame="void" rules="none">
224<col class="field-name" />
225<col class="field-body" />
226<tbody valign="top">
227<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td>
228</tr>
229</tbody>
230</table>
231</dd></dl>
232
233<dl class="method">
234<dt id="sans.models.RPA10Model.RPA10Model.run">
235<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.RPA10Model.RPA10Model.run" title="Permalink to this definition">¶</a></dt>
236<dd><p>Evaluate the model</p>
237<table class="docutils field-list" frame="void" rules="none">
238<col class="field-name" />
239<col class="field-body" />
240<tbody valign="top">
241<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [q,phi]</td>
242</tr>
243<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
244</tr>
245</tbody>
246</table>
247</dd></dl>
248
249<dl class="method">
250<dt id="sans.models.RPA10Model.RPA10Model.runXY">
251<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.RPA10Model.RPA10Model.runXY" title="Permalink to this definition">¶</a></dt>
252<dd><p>Evaluate the model</p>
253<p>: param x: input q-value (float or [float, float] as [qx, qy])
254: return: scattering function value</p>
255</dd></dl>
256
257<dl class="method">
258<dt id="sans.models.RPA10Model.RPA10Model.setParam">
259<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.RPA10Model.RPA10Model.setParam" title="Permalink to this definition">¶</a></dt>
260<dd><p>Set the value of a model parameter</p>
261<p>: param name: name of the parameter
262: param value: value of the parameter</p>
263</dd></dl>
264
265<dl class="method">
266<dt id="sans.models.RPA10Model.RPA10Model.setParamWithToken">
267<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.RPA10Model.RPA10Model.setParamWithToken" title="Permalink to this definition">¶</a></dt>
268<dd></dd></dl>
269
270<dl class="method">
271<dt id="sans.models.RPA10Model.RPA10Model.set_dispersion">
272<tt class="descname">set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.RPA10Model.RPA10Model.set_dispersion" title="Permalink to this definition">¶</a></dt>
273<dd><p>Set the dispersion object for a model parameter</p>
274<p>: param parameter: name of the parameter [string]
275:dispersion: dispersion object of type DispersionModel</p>
276</dd></dl>
277
278</dd></dl>
279
280</div>
281</div>
282
283
284          </div>
285        </div>
286      </div>
287      <div class="sphinxsidebar">
288        <div class="sphinxsidebarwrapper">
289  <h3><a href="../index.html">Table Of Contents</a></h3>
290  <ul>
291<li><a class="reference internal" href="#">RPA10Model</a><ul>
292<li><a class="reference internal" href="#sans-models-rpa10model"><tt class="docutils literal"><span class="pre">sans.models.RPA10Model</span></tt></a></li>
293</ul>
294</li>
295</ul>
296
297  <h4>Previous topic</h4>
298  <p class="topless"><a href="ReflModel.html"
299                        title="previous chapter">ReflModel</a></p>
300  <h4>Next topic</h4>
301  <p class="topless"><a href="RPAModel.html"
302                        title="next chapter">RPAModel</a></p>
303  <h3>This Page</h3>
304  <ul class="this-page-menu">
305    <li><a href="../_sources/api/RPA10Model.txt"
306           rel="nofollow">Show Source</a></li>
307  </ul>
308<div id="searchbox" style="display: none">
309  <h3>Quick search</h3>
310    <form class="search" action="../search.html" method="get">
311      <input type="text" name="q" />
312      <input type="submit" value="Go" />
313      <input type="hidden" name="check_keywords" value="yes" />
314      <input type="hidden" name="area" value="default" />
315    </form>
316    <p class="searchtip" style="font-size: 90%">
317    Enter search terms or a module, class or function name.
318    </p>
319</div>
320<script type="text/javascript">$('#searchbox').show(0);</script>
321        </div>
322      </div>
323      <div class="clearer"></div>
324    </div>
325    <div class="related">
326      <h3>Navigation</h3>
327      <ul>
328        <li class="right" style="margin-right: 10px">
329          <a href="../genindex.html" title="General Index"
330             >index</a></li>
331        <li class="right" >
332          <a href="../py-modindex.html" title="Python Module Index"
333             >modules</a> |</li>
334        <li class="right" >
335          <a href="RPAModel.html" title="RPAModel"
336             >next</a> |</li>
337        <li class="right" >
338          <a href="ReflModel.html" title="ReflModel"
339             >previous</a> |</li>
340        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li>
341          <li><a href="index.html" >Reference</a> &raquo;</li> 
342      </ul>
343    </div>
344    <div class="footer">
345        &copy; Copyright 2010, sans group.
346      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
347    </div>
348  </body>
349</html>
Note: See TracBrowser for help on using the repository browser.