source: sasview/sansmodels/docs/sphinx/_build/html/api/HayterMSAStructure.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>HayterMSAStructure &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="HollowCylinderModel" href="HollowCylinderModel.html" />
28    <link rel="prev" title="HardsphereStructure" href="HardsphereStructure.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="HollowCylinderModel.html" title="HollowCylinderModel"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="HardsphereStructure.html" title="HardsphereStructure"
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="haytermsastructure">
57<h1>HayterMSAStructure<a class="headerlink" href="#haytermsastructure" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.models.HayterMSAStructure">
59<span id="sans-models-haytermsastructure"></span><h2><a class="reference internal" href="#module-sans.models.HayterMSAStructure"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.HayterMSAStructure</span></tt></a><a class="headerlink" href="#module-sans.models.HayterMSAStructure" 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_extensionsHayterMSA.h
67AND RE-RUN THE GENERATOR SCRIPT</td>
68</tr>
69</tbody>
70</table>
71<dl class="class">
72<dt id="sans.models.HayterMSAStructure.HayterMSAStructure">
73<em class="property">class </em><tt class="descclassname">sans.models.HayterMSAStructure.</tt><tt class="descname">HayterMSAStructure</tt><a class="headerlink" href="#sans.models.HayterMSAStructure.HayterMSAStructure" title="Permalink to this definition">¶</a></dt>
74<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">CHayterMSAStructure</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 HayterMSAStructure model.
76This file was auto-generated from ..c_extensionsHayterMSA.h.
77Refer to that file and the structure it contains
78for details of the model.
79List of default parameters:</p>
80<blockquote>
81effect_radius   = 20.75 [A]
82charge          = 19.0
83volfraction     = 0.0192
84temperature     = 318.16 [K]
85saltconc        = 0.0 [M]
86dielectconst    = 71.08</blockquote>
87<dl class="method">
88<dt id="sans.models.HayterMSAStructure.HayterMSAStructure.calculate_ER">
89<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.HayterMSAStructure.HayterMSAStructure.calculate_ER" title="Permalink to this definition">¶</a></dt>
90<dd><p>Calculate the effective radius for P(q)*S(q)</p>
91<table class="docutils field-list" frame="void" rules="none">
92<col class="field-name" />
93<col class="field-body" />
94<tbody valign="top">
95<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td>
96</tr>
97</tbody>
98</table>
99</dd></dl>
100
101<dl class="method">
102<dt id="sans.models.HayterMSAStructure.HayterMSAStructure.clone">
103<tt class="descname">clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.HayterMSAStructure.HayterMSAStructure.clone" title="Permalink to this definition">¶</a></dt>
104<dd>Return a identical copy of self</dd></dl>
105
106<dl class="attribute">
107<dt id="sans.models.HayterMSAStructure.HayterMSAStructure.dispersion">
108<tt class="descname">dispersion</tt><a class="headerlink" href="#sans.models.HayterMSAStructure.HayterMSAStructure.dispersion" title="Permalink to this definition">¶</a></dt>
109<dd>Dispersion parameters</dd></dl>
110
111<dl class="method">
112<dt id="sans.models.HayterMSAStructure.HayterMSAStructure.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.HayterMSAStructure.HayterMSAStructure.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"><ul class="first simple">
120<li><strong>x</strong> &#8211; input q[], or [qx[], qy[]]</li>
121</ul>
122</td>
123</tr>
124<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">scattering function P(q[])</p>
125</td>
126</tr>
127</tbody>
128</table>
129</dd></dl>
130
131<dl class="method">
132<dt id="sans.models.HayterMSAStructure.HayterMSAStructure.getDispParamList">
133<tt class="descname">getDispParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.HayterMSAStructure.HayterMSAStructure.getDispParamList" title="Permalink to this definition">¶</a></dt>
134<dd>Return a list of all available parameters for the model</dd></dl>
135
136<dl class="method">
137<dt id="sans.models.HayterMSAStructure.HayterMSAStructure.getParam">
138<tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.HayterMSAStructure.HayterMSAStructure.getParam" title="Permalink to this definition">¶</a></dt>
139<dd><p>Set the value of a model parameter</p>
140<table class="docutils field-list" frame="void" rules="none">
141<col class="field-name" />
142<col class="field-body" />
143<tbody valign="top">
144<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
145<li><strong>name</strong> &#8211; name of the parameter</li>
146</ul>
147</td>
148</tr>
149</tbody>
150</table>
151</dd></dl>
152
153<dl class="method">
154<dt id="sans.models.HayterMSAStructure.HayterMSAStructure.getParamList">
155<tt class="descname">getParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.HayterMSAStructure.HayterMSAStructure.getParamList" title="Permalink to this definition">¶</a></dt>
156<dd>Return a list of all available parameters for the model</dd></dl>
157
158<dl class="method">
159<dt id="sans.models.HayterMSAStructure.HayterMSAStructure.getParamListWithToken">
160<tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.HayterMSAStructure.HayterMSAStructure.getParamListWithToken" title="Permalink to this definition">¶</a></dt>
161<dd></dd></dl>
162
163<dl class="method">
164<dt id="sans.models.HayterMSAStructure.HayterMSAStructure.getParamWithToken">
165<tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.HayterMSAStructure.HayterMSAStructure.getParamWithToken" title="Permalink to this definition">¶</a></dt>
166<dd></dd></dl>
167
168<dl class="method">
169<dt id="sans.models.HayterMSAStructure.HayterMSAStructure.is_fittable">
170<tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.HayterMSAStructure.HayterMSAStructure.is_fittable" title="Permalink to this definition">¶</a></dt>
171<dd><p>Check if a given parameter is fittable or not</p>
172<table class="docutils field-list" frame="void" rules="none">
173<col class="field-name" />
174<col class="field-body" />
175<tbody valign="top">
176<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
177<li><strong>par_name</strong> &#8211; the parameter name to check</li>
178</ul>
179</td>
180</tr>
181</tbody>
182</table>
183</dd></dl>
184
185<dl class="attribute">
186<dt id="sans.models.HayterMSAStructure.HayterMSAStructure.log">
187<tt class="descname">log</tt><a class="headerlink" href="#sans.models.HayterMSAStructure.HayterMSAStructure.log" title="Permalink to this definition">¶</a></dt>
188<dd>Log</dd></dl>
189
190<dl class="attribute">
191<dt id="sans.models.HayterMSAStructure.HayterMSAStructure.params">
192<tt class="descname">params</tt><a class="headerlink" href="#sans.models.HayterMSAStructure.HayterMSAStructure.params" title="Permalink to this definition">¶</a></dt>
193<dd>Parameters</dd></dl>
194
195<dl class="attribute">
196<dt id="sans.models.HayterMSAStructure.HayterMSAStructure.reset">
197<tt class="descname">reset</tt><a class="headerlink" href="#sans.models.HayterMSAStructure.HayterMSAStructure.reset" title="Permalink to this definition">¶</a></dt>
198<dd>Reset pair correlation</dd></dl>
199
200<dl class="method">
201<dt id="sans.models.HayterMSAStructure.HayterMSAStructure.run">
202<tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.HayterMSAStructure.HayterMSAStructure.run" title="Permalink to this definition">¶</a></dt>
203<dd><p>Evaluate the model</p>
204<table class="docutils field-list" frame="void" rules="none">
205<col class="field-name" />
206<col class="field-body" />
207<tbody valign="top">
208<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
209<li><strong>x</strong> &#8211; input q, or [q,phi]</li>
210</ul>
211</td>
212</tr>
213<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">scattering function P(q)</p>
214</td>
215</tr>
216</tbody>
217</table>
218</dd></dl>
219
220<dl class="method">
221<dt id="sans.models.HayterMSAStructure.HayterMSAStructure.runXY">
222<tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.HayterMSAStructure.HayterMSAStructure.runXY" title="Permalink to this definition">¶</a></dt>
223<dd><p>Evaluate the model in cartesian coordinates</p>
224<table class="docutils field-list" frame="void" rules="none">
225<col class="field-name" />
226<col class="field-body" />
227<tbody valign="top">
228<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first simple">
229<li><strong>x</strong> &#8211; input q, or [qx, qy]</li>
230</ul>
231</td>
232</tr>
233<tr class="field"><th class="field-name">Returns:</th><td class="field-body"><p class="first last">scattering function P(q)</p>
234</td>
235</tr>
236</tbody>
237</table>
238</dd></dl>
239
240<dl class="method">
241<dt id="sans.models.HayterMSAStructure.HayterMSAStructure.setParam">
242<tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.HayterMSAStructure.HayterMSAStructure.setParam" title="Permalink to this definition">¶</a></dt>
243<dd><p>Set the value of a model parameter</p>
244<table class="docutils field-list" frame="void" rules="none">
245<col class="field-name" />
246<col class="field-body" />
247<tbody valign="top">
248<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
249<li><strong>name</strong> &#8211; name of the parameter</li>
250<li><strong>value</strong> &#8211; value of the parameter</li>
251</ul>
252</td>
253</tr>
254</tbody>
255</table>
256</dd></dl>
257
258<dl class="method">
259<dt id="sans.models.HayterMSAStructure.HayterMSAStructure.setParamWithToken">
260<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.HayterMSAStructure.HayterMSAStructure.setParamWithToken" title="Permalink to this definition">¶</a></dt>
261<dd></dd></dl>
262
263<dl class="method">
264<dt id="sans.models.HayterMSAStructure.HayterMSAStructure.set_dispersion">
265<tt class="descname">set_dispersion</tt><big>(</big><em>parameter</em>, <em>dispersion</em><big>)</big><a class="headerlink" href="#sans.models.HayterMSAStructure.HayterMSAStructure.set_dispersion" title="Permalink to this definition">¶</a></dt>
266<dd><p>Set the dispersion object for a model parameter</p>
267<table class="docutils field-list" frame="void" rules="none">
268<col class="field-name" />
269<col class="field-body" />
270<tbody valign="top">
271<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
272<li><strong>parameter</strong> &#8211; name of the parameter [string]</li>
273<li><strong>dispersion</strong> &#8211; dispersion object of type DispersionModel</li>
274</ul>
275</td>
276</tr>
277</tbody>
278</table>
279</dd></dl>
280
281</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="#">HayterMSAStructure</a><ul>
295<li><a class="reference internal" href="#module-sans.models.HayterMSAStructure"><tt class="docutils literal"><span class="pre">sans.models.HayterMSAStructure</span></tt></a></li>
296</ul>
297</li>
298</ul>
299
300  <h4>Previous topic</h4>
301  <p class="topless"><a href="HardsphereStructure.html"
302                        title="previous chapter">HardsphereStructure</a></p>
303  <h4>Next topic</h4>
304  <p class="topless"><a href="HollowCylinderModel.html"
305                        title="next chapter">HollowCylinderModel</a></p>
306  <h3>This Page</h3>
307  <ul class="this-page-menu">
308    <li><a href="../_sources/api/HayterMSAStructure.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="HollowCylinderModel.html" title="HollowCylinderModel"
339             >next</a> |</li>
340        <li class="right" >
341          <a href="HardsphereStructure.html" title="HardsphereStructure"
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.0b1.
350    </div>
351  </body>
352</html>
Note: See TracBrowser for help on using the repository browser.