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