source: sasview/sansmodels/docs/sphinx/html/api/StackedDisksModel.html @ c09ace41

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 c09ace41 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>StackedDisksModel &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="StickyHSStructure" href="StickyHSStructure.html" />
31    <link rel="prev" title="SquareWellStructure" href="SquareWellStructure.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="StickyHSStructure.html" title="StickyHSStructure"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="SquareWellStructure.html" title="SquareWellStructure"
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="stackeddisksmodel">
60<h1>StackedDisksModel<a class="headerlink" href="#stackeddisksmodel" title="Permalink to this headline">¶</a></h1>
[c0d873f]61<div class="section" id="sans-models-stackeddisksmodel">
62<h2><a class="reference internal" href="#module-sans.models.StackedDisksModel" title="sans.models.StackedDisksModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.StackedDisksModel</span></tt></a><a class="headerlink" href="#sans-models-stackeddisksmodel" title="Permalink to this headline">¶</a></h2>
63<span class="target" id="module-sans.models.StackedDisksModel"></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_extensionsstacked_disks.h
70AND RE-RUN THE GENERATOR SCRIPT</td>
71</tr>
72</tbody>
73</table>
74<dl class="class">
75<dt id="sans.models.StackedDisksModel.StackedDisksModel">
76<em class="property">class </em><tt class="descclassname">sans.models.StackedDisksModel.</tt><tt class="descname">StackedDisksModel</tt><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel" title="Permalink to this definition">¶</a></dt>
77<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">CStackedDisksModel</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 StackedDisksModel model.
79This file was auto-generated from ..c_extensionsstacked_disks.h.
80Refer to that file and the structure it contains
81for details of the model.
82List of default parameters:</p>
83<blockquote>
84<div>scale           = 0.01
85radius          = 3000.0 [A]
86core_thick      = 10.0 [A]
87layer_thick     = 15.0 [A]
88core_sld        = 4e-06 [1/A^(2)]
89layer_sld       = -4e-07 [1/A^(2)]
90solvent_sld     = 5e-06 [1/A^(2)]
91n_stacking      = 1.0
92sigma_d         = 0.0
93background      = 0.001 [1/cm]
94axis_theta      = 0.0 [rad]
95axis_phi        = 0.0 [rad]</div></blockquote>
96<dl class="method">
[c0d873f]97<dt id="sans.models.StackedDisksModel.StackedDisksModel.__add__">
98<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__add__" title="Permalink to this definition">¶</a></dt>
99<dd></dd></dl>
100
101<dl class="attribute">
102<dt id="sans.models.StackedDisksModel.StackedDisksModel.__class__">
103<tt class="descname">__class__</tt><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__class__" title="Permalink to this definition">¶</a></dt>
104<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p>
105</dd></dl>
106
107<dl class="attribute">
108<dt id="sans.models.StackedDisksModel.StackedDisksModel.__delattr__">
109<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__delattr__" title="Permalink to this definition">¶</a></dt>
110<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p>
111</dd></dl>
112
113<dl class="attribute">
114<dt id="sans.models.StackedDisksModel.StackedDisksModel.__dict__">
115<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x0279B5B0&gt;</em><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__dict__" title="Permalink to this definition">¶</a></dt>
116<dd></dd></dl>
117
118<dl class="method">
119<dt id="sans.models.StackedDisksModel.StackedDisksModel.__div__">
120<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__div__" title="Permalink to this definition">¶</a></dt>
121<dd></dd></dl>
122
123<dl class="attribute">
124<dt id="sans.models.StackedDisksModel.StackedDisksModel.__getattribute__">
125<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__getattribute__" title="Permalink to this definition">¶</a></dt>
126<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p>
127</dd></dl>
128
129<dl class="attribute">
130<dt id="sans.models.StackedDisksModel.StackedDisksModel.__hash__">
131<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__hash__" title="Permalink to this definition">¶</a></dt>
132<dd><p>x.__hash__() &lt;==&gt; hash(x)</p>
133</dd></dl>
134
135<dl class="method">
136<dt id="sans.models.StackedDisksModel.StackedDisksModel.__init__">
137<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__init__" title="Permalink to this definition">¶</a></dt>
138<dd><p>Initialization</p>
139</dd></dl>
140
141<dl class="attribute">
142<dt id="sans.models.StackedDisksModel.StackedDisksModel.__module__">
143<tt class="descname">__module__</tt><em class="property"> = 'sans.models.StackedDisksModel'</em><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__module__" title="Permalink to this definition">¶</a></dt>
144<dd></dd></dl>
145
146<dl class="method">
147<dt id="sans.models.StackedDisksModel.StackedDisksModel.__mul__">
148<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__mul__" title="Permalink to this definition">¶</a></dt>
149<dd></dd></dl>
150
151<dl class="staticmethod">
152<dt id="sans.models.StackedDisksModel.StackedDisksModel.__new__">
153<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.StackedDisksModel.StackedDisksModel.__new__" title="Permalink to this definition">¶</a></dt>
154<dd></dd></dl>
155
156<dl class="method">
157<dt id="sans.models.StackedDisksModel.StackedDisksModel.__reduce__">
158<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__reduce__" title="Permalink to this definition">¶</a></dt>
159<dd><p>helper for pickle</p>
160</dd></dl>
161
162<dl class="method">
163<dt id="sans.models.StackedDisksModel.StackedDisksModel.__reduce_ex__">
164<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__reduce_ex__" title="Permalink to this definition">¶</a></dt>
165<dd><p>Overwrite the __reduce_ex__ of PyTypeObject <a href="#id1"><span class="problematic" id="id2">*</span></a>type call in the init of
166c model.</p>
167</dd></dl>
168
169<dl class="attribute">
170<dt id="sans.models.StackedDisksModel.StackedDisksModel.__repr__">
171<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__repr__" title="Permalink to this definition">¶</a></dt>
172<dd><p>x.__repr__() &lt;==&gt; repr(x)</p>
173</dd></dl>
174
175<dl class="attribute">
176<dt id="sans.models.StackedDisksModel.StackedDisksModel.__setattr__">
177<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__setattr__" title="Permalink to this definition">¶</a></dt>
178<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p>
179</dd></dl>
180
181<dl class="method">
182<dt id="sans.models.StackedDisksModel.StackedDisksModel.__setstate__">
183<tt class="descname">__setstate__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__setstate__" title="Permalink to this definition">¶</a></dt>
184<dd><p>restore the state of a model from pickle</p>
185</dd></dl>
186
187<dl class="attribute">
188<dt id="sans.models.StackedDisksModel.StackedDisksModel.__str__">
189<tt class="descname">__str__</tt><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__str__" title="Permalink to this definition">¶</a></dt>
190<dd><p>x.__str__() &lt;==&gt; str(x)</p>
191</dd></dl>
192
193<dl class="method">
194<dt id="sans.models.StackedDisksModel.StackedDisksModel.__sub__">
195<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__sub__" title="Permalink to this definition">¶</a></dt>
196<dd></dd></dl>
197
198<dl class="attribute">
199<dt id="sans.models.StackedDisksModel.StackedDisksModel.__weakref__">
200<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.__weakref__" title="Permalink to this definition">¶</a></dt>
201<dd><p>list of weak references to the object (if defined)</p>
202</dd></dl>
203
204<dl class="method">
205<dt id="sans.models.StackedDisksModel.StackedDisksModel._clone">
206<tt class="descname">_clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel._clone" title="Permalink to this definition">¶</a></dt>
207<dd><p>Internal utility function to copy the internal
208data members to a fresh copy.</p>
209</dd></dl>
210
211<dl class="method">
[512573a]212<dt id="sans.models.StackedDisksModel.StackedDisksModel.calculate_ER">
213<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.calculate_ER" title="Permalink to this definition">¶</a></dt>
214<dd><p>Calculate the effective radius for P(q)*S(q)</p>
215<table class="docutils field-list" frame="void" rules="none">
216<col class="field-name" />
217<col class="field-body" />
218<tbody valign="top">
[c0d873f]219<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td>
[512573a]220</tr>
221</tbody>
222</table>
223</dd></dl>
224
225<dl class="method">
226<dt id="sans.models.StackedDisksModel.StackedDisksModel.clone">
227<tt class="descname">clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.clone" title="Permalink to this definition">¶</a></dt>
228<dd><p>Return a identical copy of self</p>
229</dd></dl>
230
231<dl class="attribute">
232<dt id="sans.models.StackedDisksModel.StackedDisksModel.dispersion">
233<tt class="descname">dispersion</tt><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.dispersion" title="Permalink to this definition">¶</a></dt>
234<dd><p>Dispersion parameters</p>
235</dd></dl>
236
237<dl class="method">
238<dt id="sans.models.StackedDisksModel.StackedDisksModel.evalDistribution">
[c0d873f]239<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.evalDistribution" title="Permalink to this definition">¶</a></dt>
[512573a]240<dd><p>Evaluate the model in cartesian coordinates</p>
241<table class="docutils field-list" frame="void" rules="none">
242<col class="field-name" />
243<col class="field-body" />
244<tbody valign="top">
[c0d873f]245<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]246</tr>
[c0d873f]247<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td>
[512573a]248</tr>
249</tbody>
250</table>
251</dd></dl>
252
253<dl class="method">
254<dt id="sans.models.StackedDisksModel.StackedDisksModel.getDispParamList">
255<tt class="descname">getDispParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.getDispParamList" title="Permalink to this definition">¶</a></dt>
256<dd><p>Return a list of all available parameters for the model</p>
257</dd></dl>
258
259<dl class="method">
260<dt id="sans.models.StackedDisksModel.StackedDisksModel.getParam">
[c0d873f]261<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.getParam" title="Permalink to this definition">¶</a></dt>
[512573a]262<dd><p>Set the value of a model parameter</p>
263<table class="docutils field-list" frame="void" rules="none">
264<col class="field-name" />
265<col class="field-body" />
266<tbody valign="top">
[c0d873f]267<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]268</tr>
269</tbody>
270</table>
271</dd></dl>
272
273<dl class="method">
274<dt id="sans.models.StackedDisksModel.StackedDisksModel.getParamList">
275<tt class="descname">getParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.getParamList" title="Permalink to this definition">¶</a></dt>
276<dd><p>Return a list of all available parameters for the model</p>
277</dd></dl>
278
279<dl class="method">
280<dt id="sans.models.StackedDisksModel.StackedDisksModel.getParamListWithToken">
[c0d873f]281<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt>
[512573a]282<dd></dd></dl>
283
284<dl class="method">
285<dt id="sans.models.StackedDisksModel.StackedDisksModel.getParamWithToken">
[c0d873f]286<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.getParamWithToken" title="Permalink to this definition">¶</a></dt>
[512573a]287<dd></dd></dl>
288
289<dl class="method">
290<dt id="sans.models.StackedDisksModel.StackedDisksModel.is_fittable">
[c0d873f]291<tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.is_fittable" title="Permalink to this definition">¶</a></dt>
[512573a]292<dd><p>Check if a given parameter is fittable or not</p>
293<table class="docutils field-list" frame="void" rules="none">
294<col class="field-name" />
295<col class="field-body" />
296<tbody valign="top">
[c0d873f]297<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]298</tr>
299</tbody>
300</table>
301</dd></dl>
302
303<dl class="attribute">
304<dt id="sans.models.StackedDisksModel.StackedDisksModel.log">
305<tt class="descname">log</tt><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.log" title="Permalink to this definition">¶</a></dt>
306<dd><p>Log</p>
307</dd></dl>
308
309<dl class="attribute">
310<dt id="sans.models.StackedDisksModel.StackedDisksModel.params">
311<tt class="descname">params</tt><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.params" title="Permalink to this definition">¶</a></dt>
312<dd><p>Parameters</p>
313</dd></dl>
314
[c0d873f]315<dl class="method">
[512573a]316<dt id="sans.models.StackedDisksModel.StackedDisksModel.reset">
[c0d873f]317<tt class="descname">reset</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.reset" title="Permalink to this definition">¶</a></dt>
[512573a]318<dd><p>Reset pair correlation</p>
319</dd></dl>
320
321<dl class="method">
322<dt id="sans.models.StackedDisksModel.StackedDisksModel.run">
[c0d873f]323<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.run" title="Permalink to this definition">¶</a></dt>
[512573a]324<dd><p>Evaluate the model</p>
325<table class="docutils field-list" frame="void" rules="none">
326<col class="field-name" />
327<col class="field-body" />
328<tbody valign="top">
[c0d873f]329<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]330</tr>
[c0d873f]331<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
[512573a]332</tr>
333</tbody>
334</table>
335</dd></dl>
336
337<dl class="method">
338<dt id="sans.models.StackedDisksModel.StackedDisksModel.runXY">
[c0d873f]339<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.runXY" title="Permalink to this definition">¶</a></dt>
[512573a]340<dd><p>Evaluate the model in cartesian coordinates</p>
341<table class="docutils field-list" frame="void" rules="none">
342<col class="field-name" />
343<col class="field-body" />
344<tbody valign="top">
[c0d873f]345<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]346</tr>
[c0d873f]347<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
[512573a]348</tr>
349</tbody>
350</table>
351</dd></dl>
352
353<dl class="method">
354<dt id="sans.models.StackedDisksModel.StackedDisksModel.setParam">
[c0d873f]355<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.setParam" title="Permalink to this definition">¶</a></dt>
[512573a]356<dd><p>Set the value of a model parameter</p>
357<table class="docutils field-list" frame="void" rules="none">
358<col class="field-name" />
359<col class="field-body" />
360<tbody valign="top">
[c0d873f]361<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
[512573a]362<li><strong>name</strong> &#8211; name of the parameter</li>
363<li><strong>value</strong> &#8211; value of the parameter</li>
364</ul>
365</td>
366</tr>
367</tbody>
368</table>
369</dd></dl>
370
371<dl class="method">
372<dt id="sans.models.StackedDisksModel.StackedDisksModel.setParamWithToken">
[c0d873f]373<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.setParamWithToken" title="Permalink to this definition">¶</a></dt>
[512573a]374<dd></dd></dl>
375
376<dl class="method">
377<dt id="sans.models.StackedDisksModel.StackedDisksModel.set_dispersion">
[c0d873f]378<tt class="descname">set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.set_dispersion" title="Permalink to this definition">¶</a></dt>
[512573a]379<dd><p>Set the dispersion object for a model parameter</p>
380<table class="docutils field-list" frame="void" rules="none">
381<col class="field-name" />
382<col class="field-body" />
383<tbody valign="top">
[c0d873f]384<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
[512573a]385<li><strong>parameter</strong> &#8211; name of the parameter [string]</li>
386<li><strong>dispersion</strong> &#8211; dispersion object of type DispersionModel</li>
387</ul>
388</td>
389</tr>
390</tbody>
391</table>
392</dd></dl>
393
394</dd></dl>
395
396<dl class="function">
397<dt id="sans.models.StackedDisksModel.create_StackedDisksModel">
398<tt class="descclassname">sans.models.StackedDisksModel.</tt><tt class="descname">create_StackedDisksModel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.create_StackedDisksModel" title="Permalink to this definition">¶</a></dt>
399<dd></dd></dl>
400
401</div>
402</div>
403
404
405          </div>
406        </div>
407      </div>
408      <div class="sphinxsidebar">
409        <div class="sphinxsidebarwrapper">
410  <h3><a href="../index.html">Table Of Contents</a></h3>
411  <ul>
412<li><a class="reference internal" href="#">StackedDisksModel</a><ul>
[c0d873f]413<li><a class="reference internal" href="#sans-models-stackeddisksmodel"><tt class="docutils literal"><span class="pre">sans.models.StackedDisksModel</span></tt></a></li>
[512573a]414</ul>
415</li>
416</ul>
417
418  <h4>Previous topic</h4>
419  <p class="topless"><a href="SquareWellStructure.html"
420                        title="previous chapter">SquareWellStructure</a></p>
421  <h4>Next topic</h4>
422  <p class="topless"><a href="StickyHSStructure.html"
423                        title="next chapter">StickyHSStructure</a></p>
424  <h3>This Page</h3>
425  <ul class="this-page-menu">
426    <li><a href="../_sources/api/StackedDisksModel.txt"
427           rel="nofollow">Show Source</a></li>
428  </ul>
429<div id="searchbox" style="display: none">
430  <h3>Quick search</h3>
431    <form class="search" action="../search.html" method="get">
[c0d873f]432      <input type="text" name="q" />
[512573a]433      <input type="submit" value="Go" />
434      <input type="hidden" name="check_keywords" value="yes" />
435      <input type="hidden" name="area" value="default" />
436    </form>
437    <p class="searchtip" style="font-size: 90%">
438    Enter search terms or a module, class or function name.
439    </p>
440</div>
441<script type="text/javascript">$('#searchbox').show(0);</script>
442        </div>
443      </div>
444      <div class="clearer"></div>
445    </div>
446    <div class="related">
447      <h3>Navigation</h3>
448      <ul>
449        <li class="right" style="margin-right: 10px">
450          <a href="../genindex.html" title="General Index"
451             >index</a></li>
452        <li class="right" >
453          <a href="../py-modindex.html" title="Python Module Index"
454             >modules</a> |</li>
455        <li class="right" >
456          <a href="StickyHSStructure.html" title="StickyHSStructure"
457             >next</a> |</li>
458        <li class="right" >
459          <a href="SquareWellStructure.html" title="SquareWellStructure"
460             >previous</a> |</li>
[c0d873f]461        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li>
[512573a]462          <li><a href="index.html" >Reference</a> &raquo;</li> 
463      </ul>
464    </div>
465    <div class="footer">
466        &copy; Copyright 2010, sans group.
[c0d873f]467      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
[512573a]468    </div>
469  </body>
470</html>
Note: See TracBrowser for help on using the repository browser.