source: sasview/sansmodels/docs/sphinx/html/api/LamellarFFHGModel.html @ 43cc1ad2

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 43cc1ad2 was c0d873f, checked in by Gervaise Alina <gervyh@…>, 13 years ago

edit docs for models
  • Property mode set to 100644
File size: 22.7 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
7<html xmlns="http://www.w3.org/1999/xhtml">
8  <head>
9    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10   
11    <title>LamellarFFHGModel &mdash; sansmodels 0.1.0 documentation</title>
12   
13    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
14    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
15   
16    <script type="text/javascript">
17      var DOCUMENTATION_OPTIONS = {
18        URL_ROOT:    '../',
19        VERSION:     '0.1.0',
20        COLLAPSE_INDEX: false,
21        FILE_SUFFIX: '.html',
22        HAS_SOURCE:  true
23      };
24    </script>
25    <script type="text/javascript" src="../_static/jquery.js"></script>
26    <script type="text/javascript" src="../_static/underscore.js"></script>
27    <script type="text/javascript" src="../_static/doctools.js"></script>
28    <link rel="top" title="sansmodels 0.1.0 documentation" href="../index.html" />
29    <link rel="up" title="Reference" href="index.html" />
30    <link rel="next" title="LamellarModel" href="LamellarModel.html" />
31    <link rel="prev" title="HollowCylinderModel" href="HollowCylinderModel.html" /> 
32  </head>
33  <body>
34    <div class="related">
35      <h3>Navigation</h3>
36      <ul>
37        <li class="right" style="margin-right: 10px">
38          <a href="../genindex.html" title="General Index"
39             accesskey="I">index</a></li>
40        <li class="right" >
41          <a href="../py-modindex.html" title="Python Module Index"
42             >modules</a> |</li>
43        <li class="right" >
44          <a href="LamellarModel.html" title="LamellarModel"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="HollowCylinderModel.html" title="HollowCylinderModel"
48             accesskey="P">previous</a> |</li>
49        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li>
50          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li> 
51      </ul>
52    </div> 
53
54    <div class="document">
55      <div class="documentwrapper">
56        <div class="bodywrapper">
57          <div class="body">
58           
59  <div class="section" id="lamellarffhgmodel">
60<h1>LamellarFFHGModel<a class="headerlink" href="#lamellarffhgmodel" title="Permalink to this headline">¶</a></h1>
61<div class="section" id="sans-models-lamellarffhgmodel">
62<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="#sans-models-lamellarffhgmodel" title="Permalink to this headline">¶</a></h2>
63<span class="target" id="module-sans.models.LamellarFFHGModel"></span><p>Provide functionality for a C extension model</p>
64<table class="docutils field-list" frame="void" rules="none">
65<col class="field-name" />
66<col class="field-body" />
67<tbody valign="top">
68<tr class="field-odd field"><th class="field-name">WARNING:</th><td class="field-body">THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY
69DO NOT MODIFY THIS FILE, MODIFY ..c_extensionslamellarFF_HG.h
70AND RE-RUN THE GENERATOR SCRIPT</td>
71</tr>
72</tbody>
73</table>
74<dl class="class">
75<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel">
76<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>
77<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>
78<p>Class that evaluates a LamellarFFHGModel model.
79This file was auto-generated from ..c_extensionslamellarFF_HG.h.
80Refer to that file and the structure it contains
81for details of the model.
82List of default parameters:</p>
83<blockquote>
84<div>scale           = 1.0
85t_length        = 15.0 [A]
86h_thickness     = 10.0 [A]
87sld_tail        = 4e-07 [1/A^(2)]
88sld_head        = 3e-06 [1/A^(2)]
89sld_solvent     = 6e-06 [1/A^(2)]
90background      = 0.0 [1/cm]</div></blockquote>
91<dl class="method">
92<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.__add__">
93<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarFFHGModel.LamellarFFHGModel.__add__" title="Permalink to this definition">¶</a></dt>
94<dd></dd></dl>
95
96<dl class="attribute">
97<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.__class__">
98<tt class="descname">__class__</tt><a class="headerlink" href="#sans.models.LamellarFFHGModel.LamellarFFHGModel.__class__" title="Permalink to this definition">¶</a></dt>
99<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p>
100</dd></dl>
101
102<dl class="attribute">
103<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.__delattr__">
104<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.models.LamellarFFHGModel.LamellarFFHGModel.__delattr__" title="Permalink to this definition">¶</a></dt>
105<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p>
106</dd></dl>
107
108<dl class="attribute">
109<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.__dict__">
110<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x01EDC4F0&gt;</em><a class="headerlink" href="#sans.models.LamellarFFHGModel.LamellarFFHGModel.__dict__" title="Permalink to this definition">¶</a></dt>
111<dd></dd></dl>
112
113<dl class="method">
114<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.__div__">
115<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarFFHGModel.LamellarFFHGModel.__div__" title="Permalink to this definition">¶</a></dt>
116<dd></dd></dl>
117
118<dl class="attribute">
119<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.__getattribute__">
120<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.models.LamellarFFHGModel.LamellarFFHGModel.__getattribute__" title="Permalink to this definition">¶</a></dt>
121<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p>
122</dd></dl>
123
124<dl class="attribute">
125<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.__hash__">
126<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.models.LamellarFFHGModel.LamellarFFHGModel.__hash__" title="Permalink to this definition">¶</a></dt>
127<dd><p>x.__hash__() &lt;==&gt; hash(x)</p>
128</dd></dl>
129
130<dl class="method">
131<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.__init__">
132<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarFFHGModel.LamellarFFHGModel.__init__" title="Permalink to this definition">¶</a></dt>
133<dd><p>Initialization</p>
134</dd></dl>
135
136<dl class="attribute">
137<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.__module__">
138<tt class="descname">__module__</tt><em class="property"> = 'sans.models.LamellarFFHGModel'</em><a class="headerlink" href="#sans.models.LamellarFFHGModel.LamellarFFHGModel.__module__" title="Permalink to this definition">¶</a></dt>
139<dd></dd></dl>
140
141<dl class="method">
142<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.__mul__">
143<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarFFHGModel.LamellarFFHGModel.__mul__" title="Permalink to this definition">¶</a></dt>
144<dd></dd></dl>
145
146<dl class="staticmethod">
147<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.__new__">
148<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.models.LamellarFFHGModel.LamellarFFHGModel.__new__" title="Permalink to this definition">¶</a></dt>
149<dd></dd></dl>
150
151<dl class="method">
152<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.__reduce__">
153<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarFFHGModel.LamellarFFHGModel.__reduce__" title="Permalink to this definition">¶</a></dt>
154<dd><p>helper for pickle</p>
155</dd></dl>
156
157<dl class="method">
158<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.__reduce_ex__">
159<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarFFHGModel.LamellarFFHGModel.__reduce_ex__" title="Permalink to this definition">¶</a></dt>
160<dd><p>Overwrite the __reduce_ex__ of PyTypeObject <a href="#id1"><span class="problematic" id="id2">*</span></a>type call in the init of
161c model.</p>
162</dd></dl>
163
164<dl class="attribute">
165<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.__repr__">
166<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.models.LamellarFFHGModel.LamellarFFHGModel.__repr__" title="Permalink to this definition">¶</a></dt>
167<dd><p>x.__repr__() &lt;==&gt; repr(x)</p>
168</dd></dl>
169
170<dl class="attribute">
171<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.__setattr__">
172<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.models.LamellarFFHGModel.LamellarFFHGModel.__setattr__" title="Permalink to this definition">¶</a></dt>
173<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p>
174</dd></dl>
175
176<dl class="method">
177<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.__setstate__">
178<tt class="descname">__setstate__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarFFHGModel.LamellarFFHGModel.__setstate__" title="Permalink to this definition">¶</a></dt>
179<dd><p>restore the state of a model from pickle</p>
180</dd></dl>
181
182<dl class="attribute">
183<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.__str__">
184<tt class="descname">__str__</tt><a class="headerlink" href="#sans.models.LamellarFFHGModel.LamellarFFHGModel.__str__" title="Permalink to this definition">¶</a></dt>
185<dd><p>x.__str__() &lt;==&gt; str(x)</p>
186</dd></dl>
187
188<dl class="method">
189<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.__sub__">
190<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarFFHGModel.LamellarFFHGModel.__sub__" title="Permalink to this definition">¶</a></dt>
191<dd></dd></dl>
192
193<dl class="attribute">
194<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.__weakref__">
195<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.models.LamellarFFHGModel.LamellarFFHGModel.__weakref__" title="Permalink to this definition">¶</a></dt>
196<dd><p>list of weak references to the object (if defined)</p>
197</dd></dl>
198
199<dl class="method">
200<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel._clone">
201<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>
202<dd><p>Internal utility function to copy the internal
203data members to a fresh copy.</p>
204</dd></dl>
205
206<dl class="method">
207<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.calculate_ER">
208<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>
209<dd><p>Calculate the effective radius for P(q)*S(q)</p>
210<table class="docutils field-list" frame="void" rules="none">
211<col class="field-name" />
212<col class="field-body" />
213<tbody valign="top">
214<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td>
215</tr>
216</tbody>
217</table>
218</dd></dl>
219
220<dl class="method">
221<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.clone">
222<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>
223<dd><p>Return a identical copy of self</p>
224</dd></dl>
225
226<dl class="attribute">
227<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.dispersion">
228<tt class="descname">dispersion</tt><a class="headerlink" href="#sans.models.LamellarFFHGModel.LamellarFFHGModel.dispersion" title="Permalink to this definition">¶</a></dt>
229<dd><p>Dispersion parameters</p>
230</dd></dl>
231
232<dl class="method">
233<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.evalDistribution">
234<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarFFHGModel.LamellarFFHGModel.evalDistribution" title="Permalink to this definition">¶</a></dt>
235<dd><p>Evaluate the model in cartesian coordinates</p>
236<table class="docutils field-list" frame="void" rules="none">
237<col class="field-name" />
238<col class="field-body" />
239<tbody valign="top">
240<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q[], or [qx[], qy[]]</td>
241</tr>
242<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td>
243</tr>
244</tbody>
245</table>
246</dd></dl>
247
248<dl class="method">
249<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.getDispParamList">
250<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>
251<dd><p>Return a list of all available parameters for the model</p>
252</dd></dl>
253
254<dl class="method">
255<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.getParam">
256<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarFFHGModel.LamellarFFHGModel.getParam" title="Permalink to this definition">¶</a></dt>
257<dd><p>Set the value of a model parameter</p>
258<table class="docutils field-list" frame="void" rules="none">
259<col class="field-name" />
260<col class="field-body" />
261<tbody valign="top">
262<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td>
263</tr>
264</tbody>
265</table>
266</dd></dl>
267
268<dl class="method">
269<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.getParamList">
270<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>
271<dd><p>Return a list of all available parameters for the model</p>
272</dd></dl>
273
274<dl class="method">
275<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.getParamListWithToken">
276<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarFFHGModel.LamellarFFHGModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt>
277<dd></dd></dl>
278
279<dl class="method">
280<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.getParamWithToken">
281<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarFFHGModel.LamellarFFHGModel.getParamWithToken" title="Permalink to this definition">¶</a></dt>
282<dd></dd></dl>
283
284<dl class="method">
285<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.is_fittable">
286<tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarFFHGModel.LamellarFFHGModel.is_fittable" title="Permalink to this definition">¶</a></dt>
287<dd><p>Check if a given parameter is fittable or not</p>
288<table class="docutils field-list" frame="void" rules="none">
289<col class="field-name" />
290<col class="field-body" />
291<tbody valign="top">
292<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td>
293</tr>
294</tbody>
295</table>
296</dd></dl>
297
298<dl class="attribute">
299<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.log">
300<tt class="descname">log</tt><a class="headerlink" href="#sans.models.LamellarFFHGModel.LamellarFFHGModel.log" title="Permalink to this definition">¶</a></dt>
301<dd><p>Log</p>
302</dd></dl>
303
304<dl class="attribute">
305<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.params">
306<tt class="descname">params</tt><a class="headerlink" href="#sans.models.LamellarFFHGModel.LamellarFFHGModel.params" title="Permalink to this definition">¶</a></dt>
307<dd><p>Parameters</p>
308</dd></dl>
309
310<dl class="method">
311<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.reset">
312<tt class="descname">reset</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarFFHGModel.LamellarFFHGModel.reset" title="Permalink to this definition">¶</a></dt>
313<dd><p>Reset pair correlation</p>
314</dd></dl>
315
316<dl class="method">
317<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.run">
318<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarFFHGModel.LamellarFFHGModel.run" title="Permalink to this definition">¶</a></dt>
319<dd><p>Evaluate the model</p>
320<table class="docutils field-list" frame="void" rules="none">
321<col class="field-name" />
322<col class="field-body" />
323<tbody valign="top">
324<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [q,phi]</td>
325</tr>
326<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
327</tr>
328</tbody>
329</table>
330</dd></dl>
331
332<dl class="method">
333<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.runXY">
334<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarFFHGModel.LamellarFFHGModel.runXY" title="Permalink to this definition">¶</a></dt>
335<dd><p>Evaluate the model in cartesian coordinates</p>
336<table class="docutils field-list" frame="void" rules="none">
337<col class="field-name" />
338<col class="field-body" />
339<tbody valign="top">
340<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [qx, qy]</td>
341</tr>
342<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
343</tr>
344</tbody>
345</table>
346</dd></dl>
347
348<dl class="method">
349<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.setParam">
350<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarFFHGModel.LamellarFFHGModel.setParam" title="Permalink to this definition">¶</a></dt>
351<dd><p>Set the value of a model parameter</p>
352<table class="docutils field-list" frame="void" rules="none">
353<col class="field-name" />
354<col class="field-body" />
355<tbody valign="top">
356<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
357<li><strong>name</strong> &#8211; name of the parameter</li>
358<li><strong>value</strong> &#8211; value of the parameter</li>
359</ul>
360</td>
361</tr>
362</tbody>
363</table>
364</dd></dl>
365
366<dl class="method">
367<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.setParamWithToken">
368<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarFFHGModel.LamellarFFHGModel.setParamWithToken" title="Permalink to this definition">¶</a></dt>
369<dd></dd></dl>
370
371<dl class="method">
372<dt id="sans.models.LamellarFFHGModel.LamellarFFHGModel.set_dispersion">
373<tt class="descname">set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.LamellarFFHGModel.LamellarFFHGModel.set_dispersion" title="Permalink to this definition">¶</a></dt>
374<dd><p>Set the dispersion object for a model parameter</p>
375<table class="docutils field-list" frame="void" rules="none">
376<col class="field-name" />
377<col class="field-body" />
378<tbody valign="top">
379<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
380<li><strong>parameter</strong> &#8211; name of the parameter [string]</li>
381<li><strong>dispersion</strong> &#8211; dispersion object of type DispersionModel</li>
382</ul>
383</td>
384</tr>
385</tbody>
386</table>
387</dd></dl>
388
389</dd></dl>
390
391<dl class="function">
392<dt id="sans.models.LamellarFFHGModel.create_LamellarFFHGModel">
393<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>
394<dd></dd></dl>
395
396</div>
397</div>
398
399
400          </div>
401        </div>
402      </div>
403      <div class="sphinxsidebar">
404        <div class="sphinxsidebarwrapper">
405  <h3><a href="../index.html">Table Of Contents</a></h3>
406  <ul>
407<li><a class="reference internal" href="#">LamellarFFHGModel</a><ul>
408<li><a class="reference internal" href="#sans-models-lamellarffhgmodel"><tt class="docutils literal"><span class="pre">sans.models.LamellarFFHGModel</span></tt></a></li>
409</ul>
410</li>
411</ul>
412
413  <h4>Previous topic</h4>
414  <p class="topless"><a href="HollowCylinderModel.html"
415                        title="previous chapter">HollowCylinderModel</a></p>
416  <h4>Next topic</h4>
417  <p class="topless"><a href="LamellarModel.html"
418                        title="next chapter">LamellarModel</a></p>
419  <h3>This Page</h3>
420  <ul class="this-page-menu">
421    <li><a href="../_sources/api/LamellarFFHGModel.txt"
422           rel="nofollow">Show Source</a></li>
423  </ul>
424<div id="searchbox" style="display: none">
425  <h3>Quick search</h3>
426    <form class="search" action="../search.html" method="get">
427      <input type="text" name="q" />
428      <input type="submit" value="Go" />
429      <input type="hidden" name="check_keywords" value="yes" />
430      <input type="hidden" name="area" value="default" />
431    </form>
432    <p class="searchtip" style="font-size: 90%">
433    Enter search terms or a module, class or function name.
434    </p>
435</div>
436<script type="text/javascript">$('#searchbox').show(0);</script>
437        </div>
438      </div>
439      <div class="clearer"></div>
440    </div>
441    <div class="related">
442      <h3>Navigation</h3>
443      <ul>
444        <li class="right" style="margin-right: 10px">
445          <a href="../genindex.html" title="General Index"
446             >index</a></li>
447        <li class="right" >
448          <a href="../py-modindex.html" title="Python Module Index"
449             >modules</a> |</li>
450        <li class="right" >
451          <a href="LamellarModel.html" title="LamellarModel"
452             >next</a> |</li>
453        <li class="right" >
454          <a href="HollowCylinderModel.html" title="HollowCylinderModel"
455             >previous</a> |</li>
456        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li>
457          <li><a href="index.html" >Reference</a> &raquo;</li> 
458      </ul>
459    </div>
460    <div class="footer">
461        &copy; Copyright 2010, sans group.
462      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
463    </div>
464  </body>
465</html>
Note: See TracBrowser for help on using the repository browser.