source: sasview/sansmodels/docs/sphinx/html/api/SphereSLDModel.html @ 6b3edc1

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 6b3edc1 was 512573a, checked in by Jessica Tumarkin <jtumarki@…>, 13 years ago

HTML folder generated by Sphinx
  • Property mode set to 100644
File size: 17.3 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<html xmlns="http://www.w3.org/1999/xhtml">
7  <head>
8    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
9   
10    <title>SphereSLDModel &mdash; sansmodels v0.1.0 documentation</title>
11    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
12    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
13    <script type="text/javascript">
14      var DOCUMENTATION_OPTIONS = {
15        URL_ROOT:    '../',
16        VERSION:     '0.1.0',
17        COLLAPSE_INDEX: false,
18        FILE_SUFFIX: '.html',
19        HAS_SOURCE:  true
20      };
21    </script>
22    <script type="text/javascript" src="../_static/jquery.js"></script>
23    <script type="text/javascript" src="../_static/underscore.js"></script>
24    <script type="text/javascript" src="../_static/doctools.js"></script>
25    <link rel="top" title="sansmodels v0.1.0 documentation" href="../index.html" />
26    <link rel="up" title="Reference" href="index.html" />
27    <link rel="next" title="SphericalSLDModel" href="SphericalSLDModel.html" />
28    <link rel="prev" title="SphereModel" href="SphereModel.html" /> 
29  </head>
30  <body>
31    <div class="related">
32      <h3>Navigation</h3>
33      <ul>
34        <li class="right" style="margin-right: 10px">
35          <a href="../genindex.html" title="General Index"
36             accesskey="I">index</a></li>
37        <li class="right" >
38          <a href="../py-modindex.html" title="Python Module Index"
39             >modules</a> |</li>
40        <li class="right" >
41          <a href="SphericalSLDModel.html" title="SphericalSLDModel"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="SphereModel.html" title="SphereModel"
45             accesskey="P">previous</a> |</li>
46        <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li>
47          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li> 
48      </ul>
49    </div> 
50
51    <div class="document">
52      <div class="documentwrapper">
53        <div class="bodywrapper">
54          <div class="body">
55           
56  <div class="section" id="spheresldmodel">
57<h1>SphereSLDModel<a class="headerlink" href="#spheresldmodel" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.models.SphereSLDModel">
59<span id="sans-models-spheresldmodel"></span><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="#module-sans.models.SphereSLDModel" title="Permalink to this headline">¶</a></h2>
60<p>Provide functionality for a C extension model</p>
61<table class="docutils field-list" frame="void" rules="none">
62<col class="field-name" />
63<col class="field-body" />
64<tbody valign="top">
65<tr class="field"><th class="field-name">WARNING:</th><td class="field-body">THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY
66DO NOT MODIFY THIS FILE, MODIFY ..c_extensionsspheresld.h
67AND RE-RUN THE GENERATOR SCRIPT</td>
68</tr>
69</tbody>
70</table>
71<dl class="class">
72<dt id="sans.models.SphereSLDModel.SphereSLDModel">
73<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>
74<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>
75<p>Class that evaluates a SphereSLDModel model.
76This file was auto-generated from ..c_extensionsspheresld.h.
77Refer to that file and the structure it contains
78for details of the model.
79List of default parameters:</p>
80<blockquote>
81<div>n_shells        = 1.0
82scale           = 1.0
83thick_inter0    = 50.0 [A]
84func_inter0     = 0.0
85sld_core0       = 2.07e-06 [1/A^(2)]
86sld_solv        = 1e-06 [1/A^(2)]
87background      = 0.0
88sld_flat1       = 4e-06 [1/A^(2)]
89sld_flat2       = 3.5e-06 [1/A^(2)]
90sld_flat3       = 4e-06 [1/A^(2)]
91sld_flat4       = 3.5e-06 [1/A^(2)]
92sld_flat5       = 4e-06 [1/A^(2)]
93sld_flat6       = 3.5e-06 [1/A^(2)]
94sld_flat7       = 4e-06 [1/A^(2)]
95sld_flat8       = 3.5e-06 [1/A^(2)]
96sld_flat9       = 4e-06 [1/A^(2)]
97sld_flat10      = 3.5e-06 [1/A^(2)]
98thick_inter1    = 50.0 [A]
99thick_inter2    = 50.0 [A]
100thick_inter3    = 50.0 [A]
101thick_inter4    = 50.0 [A]
102thick_inter5    = 50.0 [A]
103thick_inter6    = 50.0 [A]
104thick_inter7    = 50.0 [A]
105thick_inter8    = 50.0 [A]
106thick_inter9    = 50.0 [A]
107thick_inter10   = 50.0 [A]
108thick_flat1     = 100.0 [A]
109thick_flat2     = 100.0 [A]
110thick_flat3     = 100.0 [A]
111thick_flat4     = 100.0 [A]
112thick_flat5     = 100.0 [A]
113thick_flat6     = 100.0 [A]
114thick_flat7     = 100.0 [A]
115thick_flat8     = 100.0 [A]
116thick_flat9     = 100.0 [A]
117thick_flat10    = 100.0 [A]
118func_inter1     = 0.0
119func_inter2     = 0.0
120func_inter3     = 0.0
121func_inter4     = 0.0
122func_inter5     = 0.0
123func_inter6     = 0.0
124func_inter7     = 0.0
125func_inter8     = 0.0
126func_inter9     = 0.0
127func_inter10    = 0.0
128nu_inter1       = 2.5
129nu_inter2       = 2.5
130nu_inter3       = 2.5
131nu_inter4       = 2.5
132nu_inter5       = 2.5
133nu_inter6       = 2.5
134nu_inter7       = 2.5
135nu_inter8       = 2.5
136nu_inter9       = 2.5
137nu_inter10      = 2.5
138npts_inter      = 35.0
139nu_inter0       = 2.5
140rad_core0       = 50.0 [A]</div></blockquote>
141<dl class="method">
142<dt id="sans.models.SphereSLDModel.SphereSLDModel.calculate_ER">
143<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>
144<dd><p>Calculate the effective radius for P(q)*S(q)</p>
145<table class="docutils field-list" frame="void" rules="none">
146<col class="field-name" />
147<col class="field-body" />
148<tbody valign="top">
149<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td>
150</tr>
151</tbody>
152</table>
153</dd></dl>
154
155<dl class="method">
156<dt id="sans.models.SphereSLDModel.SphereSLDModel.clone">
157<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>
158<dd><p>Return a identical copy of self</p>
159</dd></dl>
160
161<dl class="attribute">
162<dt id="sans.models.SphereSLDModel.SphereSLDModel.dispersion">
163<tt class="descname">dispersion</tt><a class="headerlink" href="#sans.models.SphereSLDModel.SphereSLDModel.dispersion" title="Permalink to this definition">¶</a></dt>
164<dd><p>Dispersion parameters</p>
165</dd></dl>
166
167<dl class="method">
168<dt id="sans.models.SphereSLDModel.SphereSLDModel.evalDistribution">
169<tt class="descname">evalDistribution</tt><big>(</big><em>x=</em><span class="optional">[</span><span class="optional">]</span><big>)</big><a class="headerlink" href="#sans.models.SphereSLDModel.SphereSLDModel.evalDistribution" title="Permalink to this definition">¶</a></dt>
170<dd><p>Evaluate the model in cartesian coordinates</p>
171<table class="docutils field-list" frame="void" rules="none">
172<col class="field-name" />
173<col class="field-body" />
174<tbody valign="top">
175<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q[], or [qx[], qy[]]</td>
176</tr>
177<tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td>
178</tr>
179</tbody>
180</table>
181</dd></dl>
182
183<dl class="method">
184<dt id="sans.models.SphereSLDModel.SphereSLDModel.getDispParamList">
185<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>
186<dd><p>Return a list of all available parameters for the model</p>
187</dd></dl>
188
189<dl class="method">
190<dt id="sans.models.SphereSLDModel.SphereSLDModel.getParam">
191<tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.SphereSLDModel.SphereSLDModel.getParam" title="Permalink to this definition">¶</a></dt>
192<dd><p>Set the value of a model parameter</p>
193<table class="docutils field-list" frame="void" rules="none">
194<col class="field-name" />
195<col class="field-body" />
196<tbody valign="top">
197<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td>
198</tr>
199</tbody>
200</table>
201</dd></dl>
202
203<dl class="method">
204<dt id="sans.models.SphereSLDModel.SphereSLDModel.getParamList">
205<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>
206<dd><p>Return a list of all available parameters for the model</p>
207</dd></dl>
208
209<dl class="method">
210<dt id="sans.models.SphereSLDModel.SphereSLDModel.getParamListWithToken">
211<tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.SphereSLDModel.SphereSLDModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt>
212<dd></dd></dl>
213
214<dl class="method">
215<dt id="sans.models.SphereSLDModel.SphereSLDModel.getParamWithToken">
216<tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.SphereSLDModel.SphereSLDModel.getParamWithToken" title="Permalink to this definition">¶</a></dt>
217<dd></dd></dl>
218
219<dl class="method">
220<dt id="sans.models.SphereSLDModel.SphereSLDModel.is_fittable">
221<tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.SphereSLDModel.SphereSLDModel.is_fittable" title="Permalink to this definition">¶</a></dt>
222<dd><p>Check if a given parameter is fittable or not</p>
223<table class="docutils field-list" frame="void" rules="none">
224<col class="field-name" />
225<col class="field-body" />
226<tbody valign="top">
227<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td>
228</tr>
229</tbody>
230</table>
231</dd></dl>
232
233<dl class="attribute">
234<dt id="sans.models.SphereSLDModel.SphereSLDModel.log">
235<tt class="descname">log</tt><a class="headerlink" href="#sans.models.SphereSLDModel.SphereSLDModel.log" title="Permalink to this definition">¶</a></dt>
236<dd><p>Log</p>
237</dd></dl>
238
239<dl class="attribute">
240<dt id="sans.models.SphereSLDModel.SphereSLDModel.params">
241<tt class="descname">params</tt><a class="headerlink" href="#sans.models.SphereSLDModel.SphereSLDModel.params" title="Permalink to this definition">¶</a></dt>
242<dd><p>Parameters</p>
243</dd></dl>
244
245<dl class="attribute">
246<dt id="sans.models.SphereSLDModel.SphereSLDModel.reset">
247<tt class="descname">reset</tt><a class="headerlink" href="#sans.models.SphereSLDModel.SphereSLDModel.reset" title="Permalink to this definition">¶</a></dt>
248<dd><p>Reset pair correlation</p>
249</dd></dl>
250
251<dl class="method">
252<dt id="sans.models.SphereSLDModel.SphereSLDModel.run">
253<tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.SphereSLDModel.SphereSLDModel.run" title="Permalink to this definition">¶</a></dt>
254<dd><p>Evaluate the model</p>
255<table class="docutils field-list" frame="void" rules="none">
256<col class="field-name" />
257<col class="field-body" />
258<tbody valign="top">
259<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [q,phi]</td>
260</tr>
261<tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
262</tr>
263</tbody>
264</table>
265</dd></dl>
266
267<dl class="method">
268<dt id="sans.models.SphereSLDModel.SphereSLDModel.runXY">
269<tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.SphereSLDModel.SphereSLDModel.runXY" title="Permalink to this definition">¶</a></dt>
270<dd><p>Evaluate the model in cartesian coordinates</p>
271<table class="docutils field-list" frame="void" rules="none">
272<col class="field-name" />
273<col class="field-body" />
274<tbody valign="top">
275<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [qx, qy]</td>
276</tr>
277<tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
278</tr>
279</tbody>
280</table>
281</dd></dl>
282
283<dl class="method">
284<dt id="sans.models.SphereSLDModel.SphereSLDModel.setParam">
285<tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.SphereSLDModel.SphereSLDModel.setParam" title="Permalink to this definition">¶</a></dt>
286<dd><p>Set the value of a model parameter</p>
287<table class="docutils field-list" frame="void" rules="none">
288<col class="field-name" />
289<col class="field-body" />
290<tbody valign="top">
291<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
292<li><strong>name</strong> &#8211; name of the parameter</li>
293<li><strong>value</strong> &#8211; value of the parameter</li>
294</ul>
295</td>
296</tr>
297</tbody>
298</table>
299</dd></dl>
300
301<dl class="method">
302<dt id="sans.models.SphereSLDModel.SphereSLDModel.setParamWithToken">
303<tt class="descname">setParamWithToken</tt><big>(</big><em>name</em>, <em>value</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.SphereSLDModel.SphereSLDModel.setParamWithToken" title="Permalink to this definition">¶</a></dt>
304<dd></dd></dl>
305
306<dl class="method">
307<dt id="sans.models.SphereSLDModel.SphereSLDModel.set_dispersion">
308<tt class="descname">set_dispersion</tt><big>(</big><em>parameter</em>, <em>dispersion</em><big>)</big><a class="headerlink" href="#sans.models.SphereSLDModel.SphereSLDModel.set_dispersion" title="Permalink to this definition">¶</a></dt>
309<dd><p>Set the dispersion object for a model parameter</p>
310<table class="docutils field-list" frame="void" rules="none">
311<col class="field-name" />
312<col class="field-body" />
313<tbody valign="top">
314<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
315<li><strong>parameter</strong> &#8211; name of the parameter [string]</li>
316<li><strong>dispersion</strong> &#8211; dispersion object of type DispersionModel</li>
317</ul>
318</td>
319</tr>
320</tbody>
321</table>
322</dd></dl>
323
324</dd></dl>
325
326<dl class="function">
327<dt id="sans.models.SphereSLDModel.create_SphereSLDModel">
328<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>
329<dd></dd></dl>
330
331</div>
332</div>
333
334
335          </div>
336        </div>
337      </div>
338      <div class="sphinxsidebar">
339        <div class="sphinxsidebarwrapper">
340  <h3><a href="../index.html">Table Of Contents</a></h3>
341  <ul>
342<li><a class="reference internal" href="#">SphereSLDModel</a><ul>
343<li><a class="reference internal" href="#module-sans.models.SphereSLDModel"><tt class="docutils literal"><span class="pre">sans.models.SphereSLDModel</span></tt></a></li>
344</ul>
345</li>
346</ul>
347
348  <h4>Previous topic</h4>
349  <p class="topless"><a href="SphereModel.html"
350                        title="previous chapter">SphereModel</a></p>
351  <h4>Next topic</h4>
352  <p class="topless"><a href="SphericalSLDModel.html"
353                        title="next chapter">SphericalSLDModel</a></p>
354  <h3>This Page</h3>
355  <ul class="this-page-menu">
356    <li><a href="../_sources/api/SphereSLDModel.txt"
357           rel="nofollow">Show Source</a></li>
358  </ul>
359<div id="searchbox" style="display: none">
360  <h3>Quick search</h3>
361    <form class="search" action="../search.html" method="get">
362      <input type="text" name="q" size="18" />
363      <input type="submit" value="Go" />
364      <input type="hidden" name="check_keywords" value="yes" />
365      <input type="hidden" name="area" value="default" />
366    </form>
367    <p class="searchtip" style="font-size: 90%">
368    Enter search terms or a module, class or function name.
369    </p>
370</div>
371<script type="text/javascript">$('#searchbox').show(0);</script>
372        </div>
373      </div>
374      <div class="clearer"></div>
375    </div>
376    <div class="related">
377      <h3>Navigation</h3>
378      <ul>
379        <li class="right" style="margin-right: 10px">
380          <a href="../genindex.html" title="General Index"
381             >index</a></li>
382        <li class="right" >
383          <a href="../py-modindex.html" title="Python Module Index"
384             >modules</a> |</li>
385        <li class="right" >
386          <a href="SphericalSLDModel.html" title="SphericalSLDModel"
387             >next</a> |</li>
388        <li class="right" >
389          <a href="SphereModel.html" title="SphereModel"
390             >previous</a> |</li>
391        <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li>
392          <li><a href="index.html" >Reference</a> &raquo;</li> 
393      </ul>
394    </div>
395    <div class="footer">
396        &copy; Copyright 2010, sans group.
397      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
398    </div>
399  </body>
400</html>
Note: See TracBrowser for help on using the repository browser.