source: sasview/sansmodels/docs/sphinx/html/api/CoreFourShellModel.html @ 846c724

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

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