source: sasview/sansmodels/docs/sphinx/html/api/DiamEllipFunc.html @ c09ace41

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

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