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

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

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