source: sasview/sansmodels/docs/sphinx/html/api/FlexCylEllipXModel.html @ c0d873f

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

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