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