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

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

edit docs for models
  • Property mode set to 100644
File size: 22.9 KB
RevLine 
[512573a]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
[c0d873f]6
[512573a]7<html xmlns="http://www.w3.org/1999/xhtml">
8  <head>
9    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10   
[c0d873f]11    <title>OnionModel &mdash; sansmodels 0.1.0 documentation</title>
12   
[512573a]13    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
14    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
[c0d873f]15   
[512573a]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>
[c0d873f]28    <link rel="top" title="sansmodels 0.1.0 documentation" href="../index.html" />
[512573a]29    <link rel="up" title="Reference" href="index.html" />
30    <link rel="next" title="ParallelepipedModel" href="ParallelepipedModel.html" />
31    <link rel="prev" title="OnionExpShellModel" href="OnionExpShellModel.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="ParallelepipedModel.html" title="ParallelepipedModel"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="OnionExpShellModel.html" title="OnionExpShellModel"
48             accesskey="P">previous</a> |</li>
[c0d873f]49        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li>
[512573a]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="onionmodel">
60<h1>OnionModel<a class="headerlink" href="#onionmodel" title="Permalink to this headline">¶</a></h1>
[c0d873f]61<div class="section" id="sans-models-onionmodel">
62<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="#sans-models-onionmodel" title="Permalink to this headline">¶</a></h2>
63<span class="target" id="module-sans.models.OnionModel"></span><p>Provide functionality for a C extension model</p>
[512573a]64<table class="docutils field-list" frame="void" rules="none">
65<col class="field-name" />
66<col class="field-body" />
67<tbody valign="top">
[c0d873f]68<tr class="field-odd field"><th class="field-name">WARNING:</th><td class="field-body">THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY
[512573a]69DO NOT MODIFY THIS FILE, MODIFY ..c_extensionsonion.h
70AND RE-RUN THE GENERATOR SCRIPT</td>
71</tr>
72</tbody>
73</table>
74<dl class="class">
75<dt id="sans.models.OnionModel.OnionModel">
76<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>
77<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>
78<p>Class that evaluates a OnionModel model.
79This file was auto-generated from ..c_extensionsonion.h.
80Refer to that file and the structure it contains
81for details of the model.
82List of default parameters:</p>
83<blockquote>
84<div>n_shells        = 1.0
85scale           = 1.0
86rad_core0       = 200.0 [A]
87sld_core0       = 1e-06 [1/A^(2)]
88sld_solv        = 6.4e-06 [1/A^(2)]
89background      = 0.0 [1/cm]
90sld_out_shell1  = 2e-06 [1/A^(2)]
91sld_out_shell2  = 2.5e-06 [1/A^(2)]
92sld_out_shell3  = 3e-06 [1/A^(2)]
93sld_out_shell4  = 3.5e-06 [1/A^(2)]
94sld_out_shell5  = 4e-06 [1/A^(2)]
95sld_out_shell6  = 4.5e-06 [1/A^(2)]
96sld_out_shell7  = 5e-06 [1/A^(2)]
97sld_out_shell8  = 5.5e-06 [1/A^(2)]
98sld_out_shell9  = 6e-06 [1/A^(2)]
99sld_out_shell10 = 6.2e-06 [1/A^(2)]
100sld_in_shell1   = 1.7e-06 [1/A^(2)]
101sld_in_shell2   = 2.2e-06 [1/A^(2)]
102sld_in_shell3   = 2.7e-06 [1/A^(2)]
103sld_in_shell4   = 3.2e-06 [1/A^(2)]
104sld_in_shell5   = 3.7e-06 [1/A^(2)]
105sld_in_shell6   = 4.2e-06 [1/A^(2)]
106sld_in_shell7   = 4.7e-06 [1/A^(2)]
107sld_in_shell8   = 5.2e-06 [1/A^(2)]
108sld_in_shell9   = 5.7e-06 [1/A^(2)]
109sld_in_shell10  = 6e-06 [1/A^(2)]
110A_shell1        = 1.0
111A_shell2        = 1.0
112A_shell3        = 1.0
113A_shell4        = 1.0
114A_shell5        = 1.0
115A_shell6        = 1.0
116A_shell7        = 1.0
117A_shell8        = 1.0
118A_shell9        = 1.0
119A_shell10       = 1.0
120thick_shell1    = 50.0 [A]
121thick_shell2    = 50.0 [A]
122thick_shell3    = 50.0 [A]
123thick_shell4    = 50.0 [A]
124thick_shell5    = 50.0 [A]
125thick_shell6    = 50.0 [A]
126thick_shell7    = 50.0 [A]
127thick_shell8    = 50.0 [A]
128thick_shell9    = 50.0 [A]
129thick_shell10   = 50.0 [A]
130func_shell1     = 2.0
131func_shell2     = 2.0
132func_shell3     = 2.0
133func_shell4     = 2.0
134func_shell5     = 2.0
135func_shell6     = 2.0
136func_shell7     = 2.0
137func_shell8     = 2.0
138func_shell9     = 2.0
139func_shell10    = 2.0</div></blockquote>
140<dl class="method">
[c0d873f]141<dt id="sans.models.OnionModel.OnionModel.__add__">
142<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionModel.OnionModel.__add__" title="Permalink to this definition">¶</a></dt>
143<dd></dd></dl>
144
145<dl class="attribute">
146<dt id="sans.models.OnionModel.OnionModel.__class__">
147<tt class="descname">__class__</tt><a class="headerlink" href="#sans.models.OnionModel.OnionModel.__class__" title="Permalink to this definition">¶</a></dt>
148<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p>
149</dd></dl>
150
151<dl class="attribute">
152<dt id="sans.models.OnionModel.OnionModel.__delattr__">
153<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.models.OnionModel.OnionModel.__delattr__" title="Permalink to this definition">¶</a></dt>
154<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p>
155</dd></dl>
156
157<dl class="attribute">
158<dt id="sans.models.OnionModel.OnionModel.__dict__">
159<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x020ACA50&gt;</em><a class="headerlink" href="#sans.models.OnionModel.OnionModel.__dict__" title="Permalink to this definition">¶</a></dt>
160<dd></dd></dl>
161
162<dl class="method">
163<dt id="sans.models.OnionModel.OnionModel.__div__">
164<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionModel.OnionModel.__div__" title="Permalink to this definition">¶</a></dt>
165<dd></dd></dl>
166
167<dl class="attribute">
168<dt id="sans.models.OnionModel.OnionModel.__getattribute__">
169<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.models.OnionModel.OnionModel.__getattribute__" title="Permalink to this definition">¶</a></dt>
170<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p>
171</dd></dl>
172
173<dl class="attribute">
174<dt id="sans.models.OnionModel.OnionModel.__hash__">
175<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.models.OnionModel.OnionModel.__hash__" title="Permalink to this definition">¶</a></dt>
176<dd><p>x.__hash__() &lt;==&gt; hash(x)</p>
177</dd></dl>
178
179<dl class="method">
180<dt id="sans.models.OnionModel.OnionModel.__init__">
181<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionModel.OnionModel.__init__" title="Permalink to this definition">¶</a></dt>
182<dd><p>Initialization</p>
183</dd></dl>
184
185<dl class="attribute">
186<dt id="sans.models.OnionModel.OnionModel.__module__">
187<tt class="descname">__module__</tt><em class="property"> = 'sans.models.OnionModel'</em><a class="headerlink" href="#sans.models.OnionModel.OnionModel.__module__" title="Permalink to this definition">¶</a></dt>
188<dd></dd></dl>
189
190<dl class="method">
191<dt id="sans.models.OnionModel.OnionModel.__mul__">
192<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionModel.OnionModel.__mul__" title="Permalink to this definition">¶</a></dt>
193<dd></dd></dl>
194
195<dl class="staticmethod">
196<dt id="sans.models.OnionModel.OnionModel.__new__">
197<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.models.OnionModel.OnionModel.__new__" title="Permalink to this definition">¶</a></dt>
198<dd></dd></dl>
199
200<dl class="method">
201<dt id="sans.models.OnionModel.OnionModel.__reduce__">
202<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionModel.OnionModel.__reduce__" title="Permalink to this definition">¶</a></dt>
203<dd><p>helper for pickle</p>
204</dd></dl>
205
206<dl class="method">
207<dt id="sans.models.OnionModel.OnionModel.__reduce_ex__">
208<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionModel.OnionModel.__reduce_ex__" title="Permalink to this definition">¶</a></dt>
209<dd><p>Overwrite the __reduce_ex__ of PyTypeObject <a href="#id1"><span class="problematic" id="id2">*</span></a>type call in the init of
210c model.</p>
211</dd></dl>
212
213<dl class="attribute">
214<dt id="sans.models.OnionModel.OnionModel.__repr__">
215<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.models.OnionModel.OnionModel.__repr__" title="Permalink to this definition">¶</a></dt>
216<dd><p>x.__repr__() &lt;==&gt; repr(x)</p>
217</dd></dl>
218
219<dl class="attribute">
220<dt id="sans.models.OnionModel.OnionModel.__setattr__">
221<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.models.OnionModel.OnionModel.__setattr__" title="Permalink to this definition">¶</a></dt>
222<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p>
223</dd></dl>
224
225<dl class="method">
226<dt id="sans.models.OnionModel.OnionModel.__setstate__">
227<tt class="descname">__setstate__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionModel.OnionModel.__setstate__" title="Permalink to this definition">¶</a></dt>
228<dd><p>restore the state of a model from pickle</p>
229</dd></dl>
230
231<dl class="attribute">
232<dt id="sans.models.OnionModel.OnionModel.__str__">
233<tt class="descname">__str__</tt><a class="headerlink" href="#sans.models.OnionModel.OnionModel.__str__" title="Permalink to this definition">¶</a></dt>
234<dd><p>x.__str__() &lt;==&gt; str(x)</p>
235</dd></dl>
236
237<dl class="method">
238<dt id="sans.models.OnionModel.OnionModel.__sub__">
239<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionModel.OnionModel.__sub__" title="Permalink to this definition">¶</a></dt>
240<dd></dd></dl>
241
242<dl class="attribute">
243<dt id="sans.models.OnionModel.OnionModel.__weakref__">
244<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.models.OnionModel.OnionModel.__weakref__" title="Permalink to this definition">¶</a></dt>
245<dd><p>list of weak references to the object (if defined)</p>
246</dd></dl>
247
248<dl class="method">
249<dt id="sans.models.OnionModel.OnionModel._clone">
250<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>
251<dd><p>Internal utility function to copy the internal
252data members to a fresh copy.</p>
253</dd></dl>
254
255<dl class="method">
[512573a]256<dt id="sans.models.OnionModel.OnionModel.calculate_ER">
257<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>
258<dd><p>Calculate the effective radius for P(q)*S(q)</p>
259<table class="docutils field-list" frame="void" rules="none">
260<col class="field-name" />
261<col class="field-body" />
262<tbody valign="top">
[c0d873f]263<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td>
[512573a]264</tr>
265</tbody>
266</table>
267</dd></dl>
268
269<dl class="method">
270<dt id="sans.models.OnionModel.OnionModel.clone">
271<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>
272<dd><p>Return a identical copy of self</p>
273</dd></dl>
274
275<dl class="attribute">
276<dt id="sans.models.OnionModel.OnionModel.dispersion">
277<tt class="descname">dispersion</tt><a class="headerlink" href="#sans.models.OnionModel.OnionModel.dispersion" title="Permalink to this definition">¶</a></dt>
278<dd><p>Dispersion parameters</p>
279</dd></dl>
280
281<dl class="method">
282<dt id="sans.models.OnionModel.OnionModel.evalDistribution">
[c0d873f]283<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionModel.OnionModel.evalDistribution" title="Permalink to this definition">¶</a></dt>
[512573a]284<dd><p>Evaluate the model in cartesian coordinates</p>
285<table class="docutils field-list" frame="void" rules="none">
286<col class="field-name" />
287<col class="field-body" />
288<tbody valign="top">
[c0d873f]289<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q[], or [qx[], qy[]]</td>
[512573a]290</tr>
[c0d873f]291<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td>
[512573a]292</tr>
293</tbody>
294</table>
295</dd></dl>
296
297<dl class="method">
298<dt id="sans.models.OnionModel.OnionModel.getDispParamList">
299<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>
300<dd><p>Return a list of all available parameters for the model</p>
301</dd></dl>
302
303<dl class="method">
304<dt id="sans.models.OnionModel.OnionModel.getParam">
[c0d873f]305<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionModel.OnionModel.getParam" title="Permalink to this definition">¶</a></dt>
[512573a]306<dd><p>Set the value of a model parameter</p>
307<table class="docutils field-list" frame="void" rules="none">
308<col class="field-name" />
309<col class="field-body" />
310<tbody valign="top">
[c0d873f]311<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td>
[512573a]312</tr>
313</tbody>
314</table>
315</dd></dl>
316
317<dl class="method">
318<dt id="sans.models.OnionModel.OnionModel.getParamList">
319<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>
320<dd><p>Return a list of all available parameters for the model</p>
321</dd></dl>
322
323<dl class="method">
324<dt id="sans.models.OnionModel.OnionModel.getParamListWithToken">
[c0d873f]325<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionModel.OnionModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt>
[512573a]326<dd></dd></dl>
327
328<dl class="method">
329<dt id="sans.models.OnionModel.OnionModel.getParamWithToken">
[c0d873f]330<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionModel.OnionModel.getParamWithToken" title="Permalink to this definition">¶</a></dt>
[512573a]331<dd></dd></dl>
332
333<dl class="method">
334<dt id="sans.models.OnionModel.OnionModel.is_fittable">
[c0d873f]335<tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionModel.OnionModel.is_fittable" title="Permalink to this definition">¶</a></dt>
[512573a]336<dd><p>Check if a given parameter is fittable or not</p>
337<table class="docutils field-list" frame="void" rules="none">
338<col class="field-name" />
339<col class="field-body" />
340<tbody valign="top">
[c0d873f]341<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>
[512573a]342</tr>
343</tbody>
344</table>
345</dd></dl>
346
347<dl class="attribute">
348<dt id="sans.models.OnionModel.OnionModel.log">
349<tt class="descname">log</tt><a class="headerlink" href="#sans.models.OnionModel.OnionModel.log" title="Permalink to this definition">¶</a></dt>
350<dd><p>Log</p>
351</dd></dl>
352
353<dl class="attribute">
354<dt id="sans.models.OnionModel.OnionModel.params">
355<tt class="descname">params</tt><a class="headerlink" href="#sans.models.OnionModel.OnionModel.params" title="Permalink to this definition">¶</a></dt>
356<dd><p>Parameters</p>
357</dd></dl>
358
[c0d873f]359<dl class="method">
[512573a]360<dt id="sans.models.OnionModel.OnionModel.reset">
[c0d873f]361<tt class="descname">reset</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionModel.OnionModel.reset" title="Permalink to this definition">¶</a></dt>
[512573a]362<dd><p>Reset pair correlation</p>
363</dd></dl>
364
365<dl class="method">
366<dt id="sans.models.OnionModel.OnionModel.run">
[c0d873f]367<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionModel.OnionModel.run" title="Permalink to this definition">¶</a></dt>
[512573a]368<dd><p>Evaluate the model</p>
369<table class="docutils field-list" frame="void" rules="none">
370<col class="field-name" />
371<col class="field-body" />
372<tbody valign="top">
[c0d873f]373<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>
[512573a]374</tr>
[c0d873f]375<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
[512573a]376</tr>
377</tbody>
378</table>
379</dd></dl>
380
381<dl class="method">
382<dt id="sans.models.OnionModel.OnionModel.runXY">
[c0d873f]383<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionModel.OnionModel.runXY" title="Permalink to this definition">¶</a></dt>
[512573a]384<dd><p>Evaluate the model in cartesian coordinates</p>
385<table class="docutils field-list" frame="void" rules="none">
386<col class="field-name" />
387<col class="field-body" />
388<tbody valign="top">
[c0d873f]389<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [qx, qy]</td>
[512573a]390</tr>
[c0d873f]391<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
[512573a]392</tr>
393</tbody>
394</table>
395</dd></dl>
396
397<dl class="method">
398<dt id="sans.models.OnionModel.OnionModel.setParam">
[c0d873f]399<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionModel.OnionModel.setParam" title="Permalink to this definition">¶</a></dt>
[512573a]400<dd><p>Set the value of a model parameter</p>
401<table class="docutils field-list" frame="void" rules="none">
402<col class="field-name" />
403<col class="field-body" />
404<tbody valign="top">
[c0d873f]405<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
[512573a]406<li><strong>name</strong> &#8211; name of the parameter</li>
407<li><strong>value</strong> &#8211; value of the parameter</li>
408</ul>
409</td>
410</tr>
411</tbody>
412</table>
413</dd></dl>
414
415<dl class="method">
416<dt id="sans.models.OnionModel.OnionModel.setParamWithToken">
[c0d873f]417<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionModel.OnionModel.setParamWithToken" title="Permalink to this definition">¶</a></dt>
[512573a]418<dd></dd></dl>
419
420<dl class="method">
421<dt id="sans.models.OnionModel.OnionModel.set_dispersion">
[c0d873f]422<tt class="descname">set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionModel.OnionModel.set_dispersion" title="Permalink to this definition">¶</a></dt>
[512573a]423<dd><p>Set the dispersion object for a model parameter</p>
424<table class="docutils field-list" frame="void" rules="none">
425<col class="field-name" />
426<col class="field-body" />
427<tbody valign="top">
[c0d873f]428<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
[512573a]429<li><strong>parameter</strong> &#8211; name of the parameter [string]</li>
430<li><strong>dispersion</strong> &#8211; dispersion object of type DispersionModel</li>
431</ul>
432</td>
433</tr>
434</tbody>
435</table>
436</dd></dl>
437
438</dd></dl>
439
440<dl class="function">
441<dt id="sans.models.OnionModel.create_OnionModel">
442<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>
443<dd></dd></dl>
444
445</div>
446</div>
447
448
449          </div>
450        </div>
451      </div>
452      <div class="sphinxsidebar">
453        <div class="sphinxsidebarwrapper">
454  <h3><a href="../index.html">Table Of Contents</a></h3>
455  <ul>
456<li><a class="reference internal" href="#">OnionModel</a><ul>
[c0d873f]457<li><a class="reference internal" href="#sans-models-onionmodel"><tt class="docutils literal"><span class="pre">sans.models.OnionModel</span></tt></a></li>
[512573a]458</ul>
459</li>
460</ul>
461
462  <h4>Previous topic</h4>
463  <p class="topless"><a href="OnionExpShellModel.html"
464                        title="previous chapter">OnionExpShellModel</a></p>
465  <h4>Next topic</h4>
466  <p class="topless"><a href="ParallelepipedModel.html"
467                        title="next chapter">ParallelepipedModel</a></p>
468  <h3>This Page</h3>
469  <ul class="this-page-menu">
470    <li><a href="../_sources/api/OnionModel.txt"
471           rel="nofollow">Show Source</a></li>
472  </ul>
473<div id="searchbox" style="display: none">
474  <h3>Quick search</h3>
475    <form class="search" action="../search.html" method="get">
[c0d873f]476      <input type="text" name="q" />
[512573a]477      <input type="submit" value="Go" />
478      <input type="hidden" name="check_keywords" value="yes" />
479      <input type="hidden" name="area" value="default" />
480    </form>
481    <p class="searchtip" style="font-size: 90%">
482    Enter search terms or a module, class or function name.
483    </p>
484</div>
485<script type="text/javascript">$('#searchbox').show(0);</script>
486        </div>
487      </div>
488      <div class="clearer"></div>
489    </div>
490    <div class="related">
491      <h3>Navigation</h3>
492      <ul>
493        <li class="right" style="margin-right: 10px">
494          <a href="../genindex.html" title="General Index"
495             >index</a></li>
496        <li class="right" >
497          <a href="../py-modindex.html" title="Python Module Index"
498             >modules</a> |</li>
499        <li class="right" >
500          <a href="ParallelepipedModel.html" title="ParallelepipedModel"
501             >next</a> |</li>
502        <li class="right" >
503          <a href="OnionExpShellModel.html" title="OnionExpShellModel"
504             >previous</a> |</li>
[c0d873f]505        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li>
[512573a]506          <li><a href="index.html" >Reference</a> &raquo;</li> 
507      </ul>
508    </div>
509    <div class="footer">
510        &copy; Copyright 2010, sans group.
[c0d873f]511      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
[512573a]512    </div>
513  </body>
514</html>
Note: See TracBrowser for help on using the repository browser.