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

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 b94945d was 79ac6f8, checked in by Gervaise Alina <gervyh@…>, 15 years ago

working on documentation
  • 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<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>StackedDisksModel &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="StickyHSStructure" href="StickyHSStructure.html" />
28    <link rel="prev" title="SquareWellStructure" href="SquareWellStructure.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="StickyHSStructure.html" title="StickyHSStructure"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="SquareWellStructure.html" title="SquareWellStructure"
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="stackeddisksmodel">
57<h1>StackedDisksModel<a class="headerlink" href="#stackeddisksmodel" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.models.StackedDisksModel">
59<span id="sans-models-stackeddisksmodel"></span><h2><a class="reference internal" href="#module-sans.models.StackedDisksModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.StackedDisksModel</span></tt></a><a class="headerlink" href="#module-sans.models.StackedDisksModel" 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_extensionsstacked_disks.h
67AND RE-RUN THE GENERATOR SCRIPT</td>
68</tr>
69</tbody>
70</table>
71<dl class="class">
72<dt id="sans.models.StackedDisksModel.StackedDisksModel">
73<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>
74<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>
75<p>Class that evaluates a StackedDisksModel model.
76This file was auto-generated from ..c_extensionsstacked_disks.h.
77Refer to that file and the structure it contains
78for details of the model.
79List of default parameters:</p>
80<blockquote>
81scale           = 0.01
82radius          = 3000.0 [A]
83core_thick      = 10.0 [A]
84layer_thick     = 15.0 [A]
85core_sld        = 4e-006 [1/A^(2)]
86layer_sld       = -4e-007 [1/A^(2)]
87solvent_sld     = 5e-006 [1/A^(2)]
88n_stacking      = 1.0
89sigma_d         = 0.0
90background      = 0.001 [1/cm]
91axis_theta      = 0.0 [rad]
92axis_phi        = 0.0 [rad]</blockquote>
93<dl class="method">
94<dt id="sans.models.StackedDisksModel.StackedDisksModel.calculate_ER">
95<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>
96<dd><p>Calculate the effective radius for P(q)*S(q)</p>
97<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"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td>
102</tr>
103</tbody>
104</table>
105</dd></dl>
106
107<dl class="method">
108<dt id="sans.models.StackedDisksModel.StackedDisksModel.clone">
109<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>
110<dd>Return a identical copy of self</dd></dl>
111
112<dl class="attribute">
113<dt id="sans.models.StackedDisksModel.StackedDisksModel.dispersion">
114<tt class="descname">dispersion</tt><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.dispersion" title="Permalink to this definition">¶</a></dt>
115<dd>Dispersion parameters</dd></dl>
116
117<dl class="method">
118<dt id="sans.models.StackedDisksModel.StackedDisksModel.evalDistribution">
119<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.StackedDisksModel.StackedDisksModel.evalDistribution" title="Permalink to this definition">¶</a></dt>
120<dd><p>Evaluate the model in cartesian coordinates</p>
121<table class="docutils field-list" frame="void" rules="none">
122<col class="field-name" />
123<col class="field-body" />
124<tbody valign="top">
125<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
126<li><strong>x</strong> &#8211; input q[], or [qx[], qy[]]</li>
127</ul>
128</td>
129</tr>
130<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">scattering function P(q[])</p>
131</td>
132</tr>
133</tbody>
134</table>
135</dd></dl>
136
137<dl class="method">
138<dt id="sans.models.StackedDisksModel.StackedDisksModel.getDispParamList">
139<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>
140<dd>Return a list of all available parameters for the model</dd></dl>
141
142<dl class="method">
143<dt id="sans.models.StackedDisksModel.StackedDisksModel.getParam">
144<tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.getParam" title="Permalink to this definition">¶</a></dt>
145<dd><p>Set the value of a model parameter</p>
146<table class="docutils field-list" frame="void" rules="none">
147<col class="field-name" />
148<col class="field-body" />
149<tbody valign="top">
150<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
151<li><strong>name</strong> &#8211; name of the parameter</li>
152</ul>
153</td>
154</tr>
155</tbody>
156</table>
157</dd></dl>
158
159<dl class="method">
160<dt id="sans.models.StackedDisksModel.StackedDisksModel.getParamList">
161<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>
162<dd>Return a list of all available parameters for the model</dd></dl>
163
164<dl class="method">
165<dt id="sans.models.StackedDisksModel.StackedDisksModel.getParamListWithToken">
166<tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt>
167<dd></dd></dl>
168
169<dl class="method">
170<dt id="sans.models.StackedDisksModel.StackedDisksModel.getParamWithToken">
171<tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.getParamWithToken" title="Permalink to this definition">¶</a></dt>
172<dd></dd></dl>
173
174<dl class="method">
175<dt id="sans.models.StackedDisksModel.StackedDisksModel.is_fittable">
176<tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.is_fittable" title="Permalink to this definition">¶</a></dt>
177<dd><p>Check if a given parameter is fittable or not</p>
178<table class="docutils field-list" frame="void" rules="none">
179<col class="field-name" />
180<col class="field-body" />
181<tbody valign="top">
182<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
183<li><strong>par_name</strong> &#8211; the parameter name to check</li>
184</ul>
185</td>
186</tr>
187</tbody>
188</table>
189</dd></dl>
190
191<dl class="attribute">
192<dt id="sans.models.StackedDisksModel.StackedDisksModel.log">
193<tt class="descname">log</tt><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.log" title="Permalink to this definition">¶</a></dt>
194<dd>Log</dd></dl>
195
196<dl class="attribute">
197<dt id="sans.models.StackedDisksModel.StackedDisksModel.params">
198<tt class="descname">params</tt><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.params" title="Permalink to this definition">¶</a></dt>
199<dd>Parameters</dd></dl>
200
201<dl class="attribute">
202<dt id="sans.models.StackedDisksModel.StackedDisksModel.reset">
203<tt class="descname">reset</tt><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.reset" title="Permalink to this definition">¶</a></dt>
204<dd>Reset pair correlation</dd></dl>
205
206<dl class="method">
207<dt id="sans.models.StackedDisksModel.StackedDisksModel.run">
208<tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.run" title="Permalink to this definition">¶</a></dt>
209<dd><p>Evaluate the model</p>
210<table class="docutils field-list" frame="void" rules="none">
211<col class="field-name" />
212<col class="field-body" />
213<tbody valign="top">
214<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
215<li><strong>x</strong> &#8211; input q, or [q,phi]</li>
216</ul>
217</td>
218</tr>
219<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">scattering function P(q)</p>
220</td>
221</tr>
222</tbody>
223</table>
224</dd></dl>
225
226<dl class="method">
227<dt id="sans.models.StackedDisksModel.StackedDisksModel.runXY">
228<tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.runXY" title="Permalink to this definition">¶</a></dt>
229<dd><p>Evaluate the model in cartesian coordinates</p>
230<table class="docutils field-list" frame="void" rules="none">
231<col class="field-name" />
232<col class="field-body" />
233<tbody valign="top">
234<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
235<li><strong>x</strong> &#8211; input q, or [qx, qy]</li>
236</ul>
237</td>
238</tr>
239<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">scattering function P(q)</p>
240</td>
241</tr>
242</tbody>
243</table>
244</dd></dl>
245
246<dl class="method">
247<dt id="sans.models.StackedDisksModel.StackedDisksModel.setParam">
248<tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.setParam" title="Permalink to this definition">¶</a></dt>
249<dd><p>Set the value of a model parameter</p>
250<table class="docutils field-list" frame="void" rules="none">
251<col class="field-name" />
252<col class="field-body" />
253<tbody valign="top">
254<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
255<li><strong>name</strong> &#8211; name of the parameter</li>
256<li><strong>value</strong> &#8211; value of the parameter</li>
257</ul>
258</td>
259</tr>
260</tbody>
261</table>
262</dd></dl>
263
264<dl class="method">
265<dt id="sans.models.StackedDisksModel.StackedDisksModel.setParamWithToken">
266<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.StackedDisksModel.StackedDisksModel.setParamWithToken" title="Permalink to this definition">¶</a></dt>
267<dd></dd></dl>
268
269<dl class="method">
270<dt id="sans.models.StackedDisksModel.StackedDisksModel.set_dispersion">
271<tt class="descname">set_dispersion</tt><big>(</big><em>parameter</em>, <em>dispersion</em><big>)</big><a class="headerlink" href="#sans.models.StackedDisksModel.StackedDisksModel.set_dispersion" title="Permalink to this definition">¶</a></dt>
272<dd><p>Set the dispersion object for a model parameter</p>
273<table class="docutils field-list" frame="void" rules="none">
274<col class="field-name" />
275<col class="field-body" />
276<tbody valign="top">
277<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
278<li><strong>parameter</strong> &#8211; name of the parameter [string]</li>
279<li><strong>dispersion</strong> &#8211; dispersion object of type DispersionModel</li>
280</ul>
281</td>
282</tr>
283</tbody>
284</table>
285</dd></dl>
286
287</dd></dl>
288
289</div>
290</div>
291
292
293          </div>
294        </div>
295      </div>
296      <div class="sphinxsidebar">
297        <div class="sphinxsidebarwrapper">
298  <h3><a href="../index.html">Table Of Contents</a></h3>
299  <ul>
300<li><a class="reference internal" href="#">StackedDisksModel</a><ul>
301<li><a class="reference internal" href="#module-sans.models.StackedDisksModel"><tt class="docutils literal"><span class="pre">sans.models.StackedDisksModel</span></tt></a></li>
302</ul>
303</li>
304</ul>
305
306  <h4>Previous topic</h4>
307  <p class="topless"><a href="SquareWellStructure.html"
308                        title="previous chapter">SquareWellStructure</a></p>
309  <h4>Next topic</h4>
310  <p class="topless"><a href="StickyHSStructure.html"
311                        title="next chapter">StickyHSStructure</a></p>
312  <h3>This Page</h3>
313  <ul class="this-page-menu">
314    <li><a href="../_sources/api/StackedDisksModel.txt"
315           rel="nofollow">Show Source</a></li>
316  </ul>
317<div id="searchbox" style="display: none">
318  <h3>Quick search</h3>
319    <form class="search" action="../search.html" method="get">
320      <input type="text" name="q" size="18" />
321      <input type="submit" value="Go" />
322      <input type="hidden" name="check_keywords" value="yes" />
323      <input type="hidden" name="area" value="default" />
324    </form>
325    <p class="searchtip" style="font-size: 90%">
326    Enter search terms or a module, class or function name.
327    </p>
328</div>
329<script type="text/javascript">$('#searchbox').show(0);</script>
330        </div>
331      </div>
332      <div class="clearer"></div>
333    </div>
334    <div class="related">
335      <h3>Navigation</h3>
336      <ul>
337        <li class="right" style="margin-right: 10px">
338          <a href="../genindex.html" title="General Index"
339             >index</a></li>
340        <li class="right" >
341          <a href="../py-modindex.html" title="Python Module Index"
342             >modules</a> |</li>
343        <li class="right" >
344          <a href="StickyHSStructure.html" title="StickyHSStructure"
345             >next</a> |</li>
346        <li class="right" >
347          <a href="SquareWellStructure.html" title="SquareWellStructure"
348             >previous</a> |</li>
349        <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li>
350          <li><a href="index.html" >Reference</a> &raquo;</li> 
351      </ul>
352    </div>
353    <div class="footer">
354        &copy; Copyright 2010, sans group.
355      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0b1.
356    </div>
357  </body>
358</html>
Note: See TracBrowser for help on using the repository browser.