source: sasview/sansmodels/docs/sphinx/_build/html/api/StickyHSStructure.html @ 0b12abb5

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

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