source: sasview/sansmodels/docs/sphinx/html/api/OnionModel.html @ 0766d6d

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 0766d6d was 512573a, checked in by Jessica Tumarkin <jtumarki@…>, 13 years ago

HTML folder generated by Sphinx
  • Property mode set to 100644
File size: 17.0 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>OnionModel &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="ParallelepipedModel" href="ParallelepipedModel.html" />
28    <link rel="prev" title="OnionExpShellModel" href="OnionExpShellModel.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="ParallelepipedModel.html" title="ParallelepipedModel"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="OnionExpShellModel.html" title="OnionExpShellModel"
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="onionmodel">
57<h1>OnionModel<a class="headerlink" href="#onionmodel" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.models.OnionModel">
59<span id="sans-models-onionmodel"></span><h2><a class="reference internal" href="#module-sans.models.OnionModel" title="sans.models.OnionModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.OnionModel</span></tt></a><a class="headerlink" href="#module-sans.models.OnionModel" 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_extensionsonion.h
67AND RE-RUN THE GENERATOR SCRIPT</td>
68</tr>
69</tbody>
70</table>
71<dl class="class">
72<dt id="sans.models.OnionModel.OnionModel">
73<em class="property">class </em><tt class="descclassname">sans.models.OnionModel.</tt><tt class="descname">OnionModel</tt><a class="headerlink" href="#sans.models.OnionModel.OnionModel" title="Permalink to this definition">¶</a></dt>
74<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">COnionModel</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>
75<p>Class that evaluates a OnionModel model.
76This file was auto-generated from ..c_extensionsonion.h.
77Refer to that file and the structure it contains
78for details of the model.
79List of default parameters:</p>
80<blockquote>
81<div>n_shells        = 1.0
82scale           = 1.0
83rad_core0       = 200.0 [A]
84sld_core0       = 1e-06 [1/A^(2)]
85sld_solv        = 6.4e-06 [1/A^(2)]
86background      = 0.0 [1/cm]
87sld_out_shell1  = 2e-06 [1/A^(2)]
88sld_out_shell2  = 2.5e-06 [1/A^(2)]
89sld_out_shell3  = 3e-06 [1/A^(2)]
90sld_out_shell4  = 3.5e-06 [1/A^(2)]
91sld_out_shell5  = 4e-06 [1/A^(2)]
92sld_out_shell6  = 4.5e-06 [1/A^(2)]
93sld_out_shell7  = 5e-06 [1/A^(2)]
94sld_out_shell8  = 5.5e-06 [1/A^(2)]
95sld_out_shell9  = 6e-06 [1/A^(2)]
96sld_out_shell10 = 6.2e-06 [1/A^(2)]
97sld_in_shell1   = 1.7e-06 [1/A^(2)]
98sld_in_shell2   = 2.2e-06 [1/A^(2)]
99sld_in_shell3   = 2.7e-06 [1/A^(2)]
100sld_in_shell4   = 3.2e-06 [1/A^(2)]
101sld_in_shell5   = 3.7e-06 [1/A^(2)]
102sld_in_shell6   = 4.2e-06 [1/A^(2)]
103sld_in_shell7   = 4.7e-06 [1/A^(2)]
104sld_in_shell8   = 5.2e-06 [1/A^(2)]
105sld_in_shell9   = 5.7e-06 [1/A^(2)]
106sld_in_shell10  = 6e-06 [1/A^(2)]
107A_shell1        = 1.0
108A_shell2        = 1.0
109A_shell3        = 1.0
110A_shell4        = 1.0
111A_shell5        = 1.0
112A_shell6        = 1.0
113A_shell7        = 1.0
114A_shell8        = 1.0
115A_shell9        = 1.0
116A_shell10       = 1.0
117thick_shell1    = 50.0 [A]
118thick_shell2    = 50.0 [A]
119thick_shell3    = 50.0 [A]
120thick_shell4    = 50.0 [A]
121thick_shell5    = 50.0 [A]
122thick_shell6    = 50.0 [A]
123thick_shell7    = 50.0 [A]
124thick_shell8    = 50.0 [A]
125thick_shell9    = 50.0 [A]
126thick_shell10   = 50.0 [A]
127func_shell1     = 2.0
128func_shell2     = 2.0
129func_shell3     = 2.0
130func_shell4     = 2.0
131func_shell5     = 2.0
132func_shell6     = 2.0
133func_shell7     = 2.0
134func_shell8     = 2.0
135func_shell9     = 2.0
136func_shell10    = 2.0</div></blockquote>
137<dl class="method">
138<dt id="sans.models.OnionModel.OnionModel.calculate_ER">
139<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionModel.OnionModel.calculate_ER" title="Permalink to this definition">¶</a></dt>
140<dd><p>Calculate the effective radius for P(q)*S(q)</p>
141<table class="docutils field-list" frame="void" rules="none">
142<col class="field-name" />
143<col class="field-body" />
144<tbody valign="top">
145<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td>
146</tr>
147</tbody>
148</table>
149</dd></dl>
150
151<dl class="method">
152<dt id="sans.models.OnionModel.OnionModel.clone">
153<tt class="descname">clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionModel.OnionModel.clone" title="Permalink to this definition">¶</a></dt>
154<dd><p>Return a identical copy of self</p>
155</dd></dl>
156
157<dl class="attribute">
158<dt id="sans.models.OnionModel.OnionModel.dispersion">
159<tt class="descname">dispersion</tt><a class="headerlink" href="#sans.models.OnionModel.OnionModel.dispersion" title="Permalink to this definition">¶</a></dt>
160<dd><p>Dispersion parameters</p>
161</dd></dl>
162
163<dl class="method">
164<dt id="sans.models.OnionModel.OnionModel.evalDistribution">
165<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.OnionModel.OnionModel.evalDistribution" title="Permalink to this definition">¶</a></dt>
166<dd><p>Evaluate the model in cartesian coordinates</p>
167<table class="docutils field-list" frame="void" rules="none">
168<col class="field-name" />
169<col class="field-body" />
170<tbody valign="top">
171<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q[], or [qx[], qy[]]</td>
172</tr>
173<tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td>
174</tr>
175</tbody>
176</table>
177</dd></dl>
178
179<dl class="method">
180<dt id="sans.models.OnionModel.OnionModel.getDispParamList">
181<tt class="descname">getDispParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionModel.OnionModel.getDispParamList" title="Permalink to this definition">¶</a></dt>
182<dd><p>Return a list of all available parameters for the model</p>
183</dd></dl>
184
185<dl class="method">
186<dt id="sans.models.OnionModel.OnionModel.getParam">
187<tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.OnionModel.OnionModel.getParam" title="Permalink to this definition">¶</a></dt>
188<dd><p>Set the value of a model parameter</p>
189<table class="docutils field-list" frame="void" rules="none">
190<col class="field-name" />
191<col class="field-body" />
192<tbody valign="top">
193<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td>
194</tr>
195</tbody>
196</table>
197</dd></dl>
198
199<dl class="method">
200<dt id="sans.models.OnionModel.OnionModel.getParamList">
201<tt class="descname">getParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionModel.OnionModel.getParamList" title="Permalink to this definition">¶</a></dt>
202<dd><p>Return a list of all available parameters for the model</p>
203</dd></dl>
204
205<dl class="method">
206<dt id="sans.models.OnionModel.OnionModel.getParamListWithToken">
207<tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.OnionModel.OnionModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt>
208<dd></dd></dl>
209
210<dl class="method">
211<dt id="sans.models.OnionModel.OnionModel.getParamWithToken">
212<tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.OnionModel.OnionModel.getParamWithToken" title="Permalink to this definition">¶</a></dt>
213<dd></dd></dl>
214
215<dl class="method">
216<dt id="sans.models.OnionModel.OnionModel.is_fittable">
217<tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.OnionModel.OnionModel.is_fittable" title="Permalink to this definition">¶</a></dt>
218<dd><p>Check if a given parameter is fittable or not</p>
219<table class="docutils field-list" frame="void" rules="none">
220<col class="field-name" />
221<col class="field-body" />
222<tbody valign="top">
223<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td>
224</tr>
225</tbody>
226</table>
227</dd></dl>
228
229<dl class="attribute">
230<dt id="sans.models.OnionModel.OnionModel.log">
231<tt class="descname">log</tt><a class="headerlink" href="#sans.models.OnionModel.OnionModel.log" title="Permalink to this definition">¶</a></dt>
232<dd><p>Log</p>
233</dd></dl>
234
235<dl class="attribute">
236<dt id="sans.models.OnionModel.OnionModel.params">
237<tt class="descname">params</tt><a class="headerlink" href="#sans.models.OnionModel.OnionModel.params" title="Permalink to this definition">¶</a></dt>
238<dd><p>Parameters</p>
239</dd></dl>
240
241<dl class="attribute">
242<dt id="sans.models.OnionModel.OnionModel.reset">
243<tt class="descname">reset</tt><a class="headerlink" href="#sans.models.OnionModel.OnionModel.reset" title="Permalink to this definition">¶</a></dt>
244<dd><p>Reset pair correlation</p>
245</dd></dl>
246
247<dl class="method">
248<dt id="sans.models.OnionModel.OnionModel.run">
249<tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.OnionModel.OnionModel.run" title="Permalink to this definition">¶</a></dt>
250<dd><p>Evaluate the model</p>
251<table class="docutils field-list" frame="void" rules="none">
252<col class="field-name" />
253<col class="field-body" />
254<tbody valign="top">
255<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [q,phi]</td>
256</tr>
257<tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
258</tr>
259</tbody>
260</table>
261</dd></dl>
262
263<dl class="method">
264<dt id="sans.models.OnionModel.OnionModel.runXY">
265<tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.OnionModel.OnionModel.runXY" title="Permalink to this definition">¶</a></dt>
266<dd><p>Evaluate the model in cartesian coordinates</p>
267<table class="docutils field-list" frame="void" rules="none">
268<col class="field-name" />
269<col class="field-body" />
270<tbody valign="top">
271<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [qx, qy]</td>
272</tr>
273<tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
274</tr>
275</tbody>
276</table>
277</dd></dl>
278
279<dl class="method">
280<dt id="sans.models.OnionModel.OnionModel.setParam">
281<tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.OnionModel.OnionModel.setParam" title="Permalink to this definition">¶</a></dt>
282<dd><p>Set the value of a model parameter</p>
283<table class="docutils field-list" frame="void" rules="none">
284<col class="field-name" />
285<col class="field-body" />
286<tbody valign="top">
287<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
288<li><strong>name</strong> &#8211; name of the parameter</li>
289<li><strong>value</strong> &#8211; value of the parameter</li>
290</ul>
291</td>
292</tr>
293</tbody>
294</table>
295</dd></dl>
296
297<dl class="method">
298<dt id="sans.models.OnionModel.OnionModel.setParamWithToken">
299<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.OnionModel.OnionModel.setParamWithToken" title="Permalink to this definition">¶</a></dt>
300<dd></dd></dl>
301
302<dl class="method">
303<dt id="sans.models.OnionModel.OnionModel.set_dispersion">
304<tt class="descname">set_dispersion</tt><big>(</big><em>parameter</em>, <em>dispersion</em><big>)</big><a class="headerlink" href="#sans.models.OnionModel.OnionModel.set_dispersion" title="Permalink to this definition">¶</a></dt>
305<dd><p>Set the dispersion object for a model parameter</p>
306<table class="docutils field-list" frame="void" rules="none">
307<col class="field-name" />
308<col class="field-body" />
309<tbody valign="top">
310<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
311<li><strong>parameter</strong> &#8211; name of the parameter [string]</li>
312<li><strong>dispersion</strong> &#8211; dispersion object of type DispersionModel</li>
313</ul>
314</td>
315</tr>
316</tbody>
317</table>
318</dd></dl>
319
320</dd></dl>
321
322<dl class="function">
323<dt id="sans.models.OnionModel.create_OnionModel">
324<tt class="descclassname">sans.models.OnionModel.</tt><tt class="descname">create_OnionModel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionModel.create_OnionModel" title="Permalink to this definition">¶</a></dt>
325<dd></dd></dl>
326
327</div>
328</div>
329
330
331          </div>
332        </div>
333      </div>
334      <div class="sphinxsidebar">
335        <div class="sphinxsidebarwrapper">
336  <h3><a href="../index.html">Table Of Contents</a></h3>
337  <ul>
338<li><a class="reference internal" href="#">OnionModel</a><ul>
339<li><a class="reference internal" href="#module-sans.models.OnionModel"><tt class="docutils literal"><span class="pre">sans.models.OnionModel</span></tt></a></li>
340</ul>
341</li>
342</ul>
343
344  <h4>Previous topic</h4>
345  <p class="topless"><a href="OnionExpShellModel.html"
346                        title="previous chapter">OnionExpShellModel</a></p>
347  <h4>Next topic</h4>
348  <p class="topless"><a href="ParallelepipedModel.html"
349                        title="next chapter">ParallelepipedModel</a></p>
350  <h3>This Page</h3>
351  <ul class="this-page-menu">
352    <li><a href="../_sources/api/OnionModel.txt"
353           rel="nofollow">Show Source</a></li>
354  </ul>
355<div id="searchbox" style="display: none">
356  <h3>Quick search</h3>
357    <form class="search" action="../search.html" method="get">
358      <input type="text" name="q" size="18" />
359      <input type="submit" value="Go" />
360      <input type="hidden" name="check_keywords" value="yes" />
361      <input type="hidden" name="area" value="default" />
362    </form>
363    <p class="searchtip" style="font-size: 90%">
364    Enter search terms or a module, class or function name.
365    </p>
366</div>
367<script type="text/javascript">$('#searchbox').show(0);</script>
368        </div>
369      </div>
370      <div class="clearer"></div>
371    </div>
372    <div class="related">
373      <h3>Navigation</h3>
374      <ul>
375        <li class="right" style="margin-right: 10px">
376          <a href="../genindex.html" title="General Index"
377             >index</a></li>
378        <li class="right" >
379          <a href="../py-modindex.html" title="Python Module Index"
380             >modules</a> |</li>
381        <li class="right" >
382          <a href="ParallelepipedModel.html" title="ParallelepipedModel"
383             >next</a> |</li>
384        <li class="right" >
385          <a href="OnionExpShellModel.html" title="OnionExpShellModel"
386             >previous</a> |</li>
387        <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li>
388          <li><a href="index.html" >Reference</a> &raquo;</li> 
389      </ul>
390    </div>
391    <div class="footer">
392        &copy; Copyright 2010, sans group.
393      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
394    </div>
395  </body>
396</html>
Note: See TracBrowser for help on using the repository browser.