source: sasview/sansmodels/docs/sphinx/html/api/LamellarPSHGModel.html @ dcbd084f

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

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