source: sasview/sansmodels/docs/sphinx/html/api/SphereModel.html @ 7e7e806

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

HTML folder generated by Sphinx
  • Property mode set to 100644
File size: 15.5 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>SphereModel &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="SphereSLDModel" href="SphereSLDModel.html" />
28    <link rel="prev" title="smearing_2d" href="smearing_2d.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="SphereSLDModel.html" title="SphereSLDModel"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="smearing_2d.html" title="smearing_2d"
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="spheremodel">
57<h1>SphereModel<a class="headerlink" href="#spheremodel" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.models.SphereModel">
59<span id="sans-models-spheremodel"></span><h2><a class="reference internal" href="#module-sans.models.SphereModel" title="sans.models.SphereModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.SphereModel</span></tt></a><a class="headerlink" href="#module-sans.models.SphereModel" 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_extensionssphere.h
67AND RE-RUN THE GENERATOR SCRIPT</td>
68</tr>
69</tbody>
70</table>
71<dl class="class">
72<dt id="sans.models.SphereModel.SphereModel">
73<em class="property">class </em><tt class="descclassname">sans.models.SphereModel.</tt><tt class="descname">SphereModel</tt><a class="headerlink" href="#sans.models.SphereModel.SphereModel" title="Permalink to this definition">¶</a></dt>
74<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">CSphereModel</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 SphereModel model.
76This file was auto-generated from ..c_extensionssphere.h.
77Refer to that file and the structure it contains
78for details of the model.
79List of default parameters:</p>
80<blockquote>
81<div>scale           = 1.0
82radius          = 60.0 [A]
83sldSph          = 2e-06 [1/A^(2)]
84sldSolv         = 1e-06 [1/A^(2)]
85background      = 0.0 [1/cm]</div></blockquote>
86<dl class="method">
87<dt id="sans.models.SphereModel.SphereModel.calculate_ER">
88<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SphereModel.SphereModel.calculate_ER" title="Permalink to this definition">¶</a></dt>
89<dd><p>Calculate the effective radius for P(q)*S(q)</p>
90<table class="docutils field-list" frame="void" rules="none">
91<col class="field-name" />
92<col class="field-body" />
93<tbody valign="top">
94<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td>
95</tr>
96</tbody>
97</table>
98</dd></dl>
99
100<dl class="method">
101<dt id="sans.models.SphereModel.SphereModel.clone">
102<tt class="descname">clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SphereModel.SphereModel.clone" title="Permalink to this definition">¶</a></dt>
103<dd><p>Return a identical copy of self</p>
104</dd></dl>
105
106<dl class="attribute">
107<dt id="sans.models.SphereModel.SphereModel.dispersion">
108<tt class="descname">dispersion</tt><a class="headerlink" href="#sans.models.SphereModel.SphereModel.dispersion" title="Permalink to this definition">¶</a></dt>
109<dd><p>Dispersion parameters</p>
110</dd></dl>
111
112<dl class="method">
113<dt id="sans.models.SphereModel.SphereModel.evalDistribution">
114<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.SphereModel.SphereModel.evalDistribution" title="Permalink to this definition">¶</a></dt>
115<dd><p>Evaluate the model in cartesian coordinates</p>
116<table class="docutils field-list" frame="void" rules="none">
117<col class="field-name" />
118<col class="field-body" />
119<tbody valign="top">
120<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q[], or [qx[], qy[]]</td>
121</tr>
122<tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td>
123</tr>
124</tbody>
125</table>
126</dd></dl>
127
128<dl class="method">
129<dt id="sans.models.SphereModel.SphereModel.getDispParamList">
130<tt class="descname">getDispParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SphereModel.SphereModel.getDispParamList" title="Permalink to this definition">¶</a></dt>
131<dd><p>Return a list of all available parameters for the model</p>
132</dd></dl>
133
134<dl class="method">
135<dt id="sans.models.SphereModel.SphereModel.getParam">
136<tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.SphereModel.SphereModel.getParam" title="Permalink to this definition">¶</a></dt>
137<dd><p>Set the value of a model parameter</p>
138<table class="docutils field-list" frame="void" rules="none">
139<col class="field-name" />
140<col class="field-body" />
141<tbody valign="top">
142<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td>
143</tr>
144</tbody>
145</table>
146</dd></dl>
147
148<dl class="method">
149<dt id="sans.models.SphereModel.SphereModel.getParamList">
150<tt class="descname">getParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SphereModel.SphereModel.getParamList" title="Permalink to this definition">¶</a></dt>
151<dd><p>Return a list of all available parameters for the model</p>
152</dd></dl>
153
154<dl class="method">
155<dt id="sans.models.SphereModel.SphereModel.getParamListWithToken">
156<tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.SphereModel.SphereModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt>
157<dd></dd></dl>
158
159<dl class="method">
160<dt id="sans.models.SphereModel.SphereModel.getParamWithToken">
161<tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.SphereModel.SphereModel.getParamWithToken" title="Permalink to this definition">¶</a></dt>
162<dd></dd></dl>
163
164<dl class="method">
165<dt id="sans.models.SphereModel.SphereModel.is_fittable">
166<tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.SphereModel.SphereModel.is_fittable" title="Permalink to this definition">¶</a></dt>
167<dd><p>Check if a given parameter is fittable or not</p>
168<table class="docutils field-list" frame="void" rules="none">
169<col class="field-name" />
170<col class="field-body" />
171<tbody valign="top">
172<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td>
173</tr>
174</tbody>
175</table>
176</dd></dl>
177
178<dl class="attribute">
179<dt id="sans.models.SphereModel.SphereModel.log">
180<tt class="descname">log</tt><a class="headerlink" href="#sans.models.SphereModel.SphereModel.log" title="Permalink to this definition">¶</a></dt>
181<dd><p>Log</p>
182</dd></dl>
183
184<dl class="attribute">
185<dt id="sans.models.SphereModel.SphereModel.params">
186<tt class="descname">params</tt><a class="headerlink" href="#sans.models.SphereModel.SphereModel.params" title="Permalink to this definition">¶</a></dt>
187<dd><p>Parameters</p>
188</dd></dl>
189
190<dl class="attribute">
191<dt id="sans.models.SphereModel.SphereModel.reset">
192<tt class="descname">reset</tt><a class="headerlink" href="#sans.models.SphereModel.SphereModel.reset" title="Permalink to this definition">¶</a></dt>
193<dd><p>Reset pair correlation</p>
194</dd></dl>
195
196<dl class="method">
197<dt id="sans.models.SphereModel.SphereModel.run">
198<tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.SphereModel.SphereModel.run" title="Permalink to this definition">¶</a></dt>
199<dd><p>Evaluate the model</p>
200<table class="docutils field-list" frame="void" rules="none">
201<col class="field-name" />
202<col class="field-body" />
203<tbody valign="top">
204<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [q,phi]</td>
205</tr>
206<tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
207</tr>
208</tbody>
209</table>
210</dd></dl>
211
212<dl class="method">
213<dt id="sans.models.SphereModel.SphereModel.runXY">
214<tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.SphereModel.SphereModel.runXY" title="Permalink to this definition">¶</a></dt>
215<dd><p>Evaluate the model in cartesian coordinates</p>
216<table class="docutils field-list" frame="void" rules="none">
217<col class="field-name" />
218<col class="field-body" />
219<tbody valign="top">
220<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [qx, qy]</td>
221</tr>
222<tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
223</tr>
224</tbody>
225</table>
226</dd></dl>
227
228<dl class="method">
229<dt id="sans.models.SphereModel.SphereModel.setParam">
230<tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.SphereModel.SphereModel.setParam" title="Permalink to this definition">¶</a></dt>
231<dd><p>Set the value of a model parameter</p>
232<table class="docutils field-list" frame="void" rules="none">
233<col class="field-name" />
234<col class="field-body" />
235<tbody valign="top">
236<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
237<li><strong>name</strong> &#8211; name of the parameter</li>
238<li><strong>value</strong> &#8211; value of the parameter</li>
239</ul>
240</td>
241</tr>
242</tbody>
243</table>
244</dd></dl>
245
246<dl class="method">
247<dt id="sans.models.SphereModel.SphereModel.setParamWithToken">
248<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.SphereModel.SphereModel.setParamWithToken" title="Permalink to this definition">¶</a></dt>
249<dd></dd></dl>
250
251<dl class="method">
252<dt id="sans.models.SphereModel.SphereModel.set_dispersion">
253<tt class="descname">set_dispersion</tt><big>(</big><em>parameter</em>, <em>dispersion</em><big>)</big><a class="headerlink" href="#sans.models.SphereModel.SphereModel.set_dispersion" title="Permalink to this definition">¶</a></dt>
254<dd><p>Set the dispersion object for a model parameter</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"><ul class="first last simple">
260<li><strong>parameter</strong> &#8211; name of the parameter [string]</li>
261<li><strong>dispersion</strong> &#8211; dispersion object of type DispersionModel</li>
262</ul>
263</td>
264</tr>
265</tbody>
266</table>
267</dd></dl>
268
269</dd></dl>
270
271<dl class="function">
272<dt id="sans.models.SphereModel.create_SphereModel">
273<tt class="descclassname">sans.models.SphereModel.</tt><tt class="descname">create_SphereModel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.SphereModel.create_SphereModel" title="Permalink to this definition">¶</a></dt>
274<dd></dd></dl>
275
276</div>
277</div>
278
279
280          </div>
281        </div>
282      </div>
283      <div class="sphinxsidebar">
284        <div class="sphinxsidebarwrapper">
285  <h3><a href="../index.html">Table Of Contents</a></h3>
286  <ul>
287<li><a class="reference internal" href="#">SphereModel</a><ul>
288<li><a class="reference internal" href="#module-sans.models.SphereModel"><tt class="docutils literal"><span class="pre">sans.models.SphereModel</span></tt></a></li>
289</ul>
290</li>
291</ul>
292
293  <h4>Previous topic</h4>
294  <p class="topless"><a href="smearing_2d.html"
295                        title="previous chapter">smearing_2d</a></p>
296  <h4>Next topic</h4>
297  <p class="topless"><a href="SphereSLDModel.html"
298                        title="next chapter">SphereSLDModel</a></p>
299  <h3>This Page</h3>
300  <ul class="this-page-menu">
301    <li><a href="../_sources/api/SphereModel.txt"
302           rel="nofollow">Show Source</a></li>
303  </ul>
304<div id="searchbox" style="display: none">
305  <h3>Quick search</h3>
306    <form class="search" action="../search.html" method="get">
307      <input type="text" name="q" size="18" />
308      <input type="submit" value="Go" />
309      <input type="hidden" name="check_keywords" value="yes" />
310      <input type="hidden" name="area" value="default" />
311    </form>
312    <p class="searchtip" style="font-size: 90%">
313    Enter search terms or a module, class or function name.
314    </p>
315</div>
316<script type="text/javascript">$('#searchbox').show(0);</script>
317        </div>
318      </div>
319      <div class="clearer"></div>
320    </div>
321    <div class="related">
322      <h3>Navigation</h3>
323      <ul>
324        <li class="right" style="margin-right: 10px">
325          <a href="../genindex.html" title="General Index"
326             >index</a></li>
327        <li class="right" >
328          <a href="../py-modindex.html" title="Python Module Index"
329             >modules</a> |</li>
330        <li class="right" >
331          <a href="SphereSLDModel.html" title="SphereSLDModel"
332             >next</a> |</li>
333        <li class="right" >
334          <a href="smearing_2d.html" title="smearing_2d"
335             >previous</a> |</li>
336        <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li>
337          <li><a href="index.html" >Reference</a> &raquo;</li> 
338      </ul>
339    </div>
340    <div class="footer">
341        &copy; Copyright 2010, sans group.
342      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
343    </div>
344  </body>
345</html>
Note: See TracBrowser for help on using the repository browser.