source: sasview/sansmodels/docs/sphinx/_build/html/api/SphereModel.html @ d0d7704

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 d0d7704 was 79ac6f8, checked in by Gervaise Alina <gervyh@…>, 14 years ago

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