source: sasview/sansmodels/docs/sphinx/html/api/LamellarFFHGModel.html @ 650fd318

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

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