source: sasview/sansmodels/docs/sphinx/html/api/SphereSLDModel.html @ 6232a6f

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

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