source: sasview/sansmodels/docs/sphinx/html/api/CoreShellEllipsoidModel.html @ 512573a

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

HTML folder generated by Sphinx
  • Property mode set to 100644
File size: 17.0 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>CoreShellEllipsoidModel &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="CoreShellModel" href="CoreShellModel.html" />
28    <link rel="prev" title="CoreShellCylinderModel" href="CoreShellCylinderModel.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="CoreShellModel.html" title="CoreShellModel"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="CoreShellCylinderModel.html" title="CoreShellCylinderModel"
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="coreshellellipsoidmodel">
57<h1>CoreShellEllipsoidModel<a class="headerlink" href="#coreshellellipsoidmodel" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.models.CoreShellEllipsoidModel">
59<span id="sans-models-coreshellellipsoidmodel"></span><h2><a class="reference internal" href="#module-sans.models.CoreShellEllipsoidModel" title="sans.models.CoreShellEllipsoidModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.CoreShellEllipsoidModel</span></tt></a><a class="headerlink" href="#module-sans.models.CoreShellEllipsoidModel" 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_extensionsspheroid.h
67AND RE-RUN THE GENERATOR SCRIPT</td>
68</tr>
69</tbody>
70</table>
71<dl class="class">
72<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel">
73<em class="property">class </em><tt class="descclassname">sans.models.CoreShellEllipsoidModel.</tt><tt class="descname">CoreShellEllipsoidModel</tt><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel" title="Permalink to this definition">¶</a></dt>
74<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">CCoreShellEllipsoidModel</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 CoreShellEllipsoidModel model.
76This file was auto-generated from ..c_extensionsspheroid.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
82equat_core      = 200.0 [A]
83polar_core      = 20.0 [A]
84equat_shell     = 250.0 [A]
85polar_shell     = 30.0 [A]
86sld_core        = 2e-06 [1/A^(2)]
87sld_shell       = 1e-06 [1/A^(2)]
88sld_solvent     = 6.3e-06 [1/A^(2)]
89background      = 0.001 [1/cm]
90axis_theta      = 0.0 [deg]
91axis_phi        = 0.0 [deg]</div></blockquote>
92<dl class="method">
93<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.calculate_ER">
94<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.calculate_ER" title="Permalink to this definition">¶</a></dt>
95<dd><p>Calculate the effective radius for P(q)*S(q)</p>
96<table class="docutils field-list" frame="void" rules="none">
97<col class="field-name" />
98<col class="field-body" />
99<tbody valign="top">
100<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td>
101</tr>
102</tbody>
103</table>
104</dd></dl>
105
106<dl class="method">
107<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.clone">
108<tt class="descname">clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.clone" title="Permalink to this definition">¶</a></dt>
109<dd><p>Return a identical copy of self</p>
110</dd></dl>
111
112<dl class="attribute">
113<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.dispersion">
114<tt class="descname">dispersion</tt><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.dispersion" title="Permalink to this definition">¶</a></dt>
115<dd><p>Dispersion parameters</p>
116</dd></dl>
117
118<dl class="method">
119<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.evalDistribution">
120<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.CoreShellEllipsoidModel.CoreShellEllipsoidModel.evalDistribution" title="Permalink to this definition">¶</a></dt>
121<dd><p>Evaluate the model in cartesian coordinates</p>
122<table class="docutils field-list" frame="void" rules="none">
123<col class="field-name" />
124<col class="field-body" />
125<tbody valign="top">
126<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q[], or [qx[], qy[]]</td>
127</tr>
128<tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td>
129</tr>
130</tbody>
131</table>
132</dd></dl>
133
134<dl class="method">
135<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.getDispParamList">
136<tt class="descname">getDispParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.getDispParamList" title="Permalink to this definition">¶</a></dt>
137<dd><p>Return a list of all available parameters for the model</p>
138</dd></dl>
139
140<dl class="method">
141<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.getParam">
142<tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.getParam" title="Permalink to this definition">¶</a></dt>
143<dd><p>Set the value of a model parameter</p>
144<table class="docutils field-list" frame="void" rules="none">
145<col class="field-name" />
146<col class="field-body" />
147<tbody valign="top">
148<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td>
149</tr>
150</tbody>
151</table>
152</dd></dl>
153
154<dl class="method">
155<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.getParamList">
156<tt class="descname">getParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.getParamList" title="Permalink to this definition">¶</a></dt>
157<dd><p>Return a list of all available parameters for the model</p>
158</dd></dl>
159
160<dl class="method">
161<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.getParamListWithToken">
162<tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt>
163<dd></dd></dl>
164
165<dl class="method">
166<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.getParamWithToken">
167<tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.getParamWithToken" title="Permalink to this definition">¶</a></dt>
168<dd></dd></dl>
169
170<dl class="method">
171<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.is_fittable">
172<tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.is_fittable" title="Permalink to this definition">¶</a></dt>
173<dd><p>Check if a given parameter is fittable or not</p>
174<table class="docutils field-list" frame="void" rules="none">
175<col class="field-name" />
176<col class="field-body" />
177<tbody valign="top">
178<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td>
179</tr>
180</tbody>
181</table>
182</dd></dl>
183
184<dl class="attribute">
185<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.log">
186<tt class="descname">log</tt><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.log" title="Permalink to this definition">¶</a></dt>
187<dd><p>Log</p>
188</dd></dl>
189
190<dl class="attribute">
191<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.params">
192<tt class="descname">params</tt><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.params" title="Permalink to this definition">¶</a></dt>
193<dd><p>Parameters</p>
194</dd></dl>
195
196<dl class="attribute">
197<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.reset">
198<tt class="descname">reset</tt><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.reset" title="Permalink to this definition">¶</a></dt>
199<dd><p>Reset pair correlation</p>
200</dd></dl>
201
202<dl class="method">
203<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.run">
204<tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.run" title="Permalink to this definition">¶</a></dt>
205<dd><p>Evaluate the model</p>
206<table class="docutils field-list" frame="void" rules="none">
207<col class="field-name" />
208<col class="field-body" />
209<tbody valign="top">
210<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [q,phi]</td>
211</tr>
212<tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
213</tr>
214</tbody>
215</table>
216</dd></dl>
217
218<dl class="method">
219<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.runXY">
220<tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.runXY" title="Permalink to this definition">¶</a></dt>
221<dd><p>Evaluate the model in cartesian coordinates</p>
222<table class="docutils field-list" frame="void" rules="none">
223<col class="field-name" />
224<col class="field-body" />
225<tbody valign="top">
226<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [qx, qy]</td>
227</tr>
228<tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
229</tr>
230</tbody>
231</table>
232</dd></dl>
233
234<dl class="method">
235<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.setParam">
236<tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.setParam" title="Permalink to this definition">¶</a></dt>
237<dd><p>Set the value of a model parameter</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"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
243<li><strong>name</strong> &#8211; name of the parameter</li>
244<li><strong>value</strong> &#8211; value of the parameter</li>
245</ul>
246</td>
247</tr>
248</tbody>
249</table>
250</dd></dl>
251
252<dl class="method">
253<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.setParamWithToken">
254<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.CoreShellEllipsoidModel.CoreShellEllipsoidModel.setParamWithToken" title="Permalink to this definition">¶</a></dt>
255<dd></dd></dl>
256
257<dl class="method">
258<dt id="sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.set_dispersion">
259<tt class="descname">set_dispersion</tt><big>(</big><em>parameter</em>, <em>dispersion</em><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.CoreShellEllipsoidModel.set_dispersion" title="Permalink to this definition">¶</a></dt>
260<dd><p>Set the dispersion object for a model parameter</p>
261<table class="docutils field-list" frame="void" rules="none">
262<col class="field-name" />
263<col class="field-body" />
264<tbody valign="top">
265<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
266<li><strong>parameter</strong> &#8211; name of the parameter [string]</li>
267<li><strong>dispersion</strong> &#8211; dispersion object of type DispersionModel</li>
268</ul>
269</td>
270</tr>
271</tbody>
272</table>
273</dd></dl>
274
275</dd></dl>
276
277<dl class="function">
278<dt id="sans.models.CoreShellEllipsoidModel.create_CoreShellEllipsoidModel">
279<tt class="descclassname">sans.models.CoreShellEllipsoidModel.</tt><tt class="descname">create_CoreShellEllipsoidModel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreShellEllipsoidModel.create_CoreShellEllipsoidModel" title="Permalink to this definition">¶</a></dt>
280<dd></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="#">CoreShellEllipsoidModel</a><ul>
294<li><a class="reference internal" href="#module-sans.models.CoreShellEllipsoidModel"><tt class="docutils literal"><span class="pre">sans.models.CoreShellEllipsoidModel</span></tt></a></li>
295</ul>
296</li>
297</ul>
298
299  <h4>Previous topic</h4>
300  <p class="topless"><a href="CoreShellCylinderModel.html"
301                        title="previous chapter">CoreShellCylinderModel</a></p>
302  <h4>Next topic</h4>
303  <p class="topless"><a href="CoreShellModel.html"
304                        title="next chapter">CoreShellModel</a></p>
305  <h3>This Page</h3>
306  <ul class="this-page-menu">
307    <li><a href="../_sources/api/CoreShellEllipsoidModel.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="CoreShellModel.html" title="CoreShellModel"
338             >next</a> |</li>
339        <li class="right" >
340          <a href="CoreShellCylinderModel.html" title="CoreShellCylinderModel"
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.0.7.
349    </div>
350  </body>
351</html>
Note: See TracBrowser for help on using the repository browser.