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