source: sasview/sansmodels/docs/sphinx/html/api/CoreShellEllipsoidModel.html @ 8d70c0a

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

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