source: sasview/sansmodels/docs/sphinx/html/api/CoreMultiShellModel.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: 12.8 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>CoreMultiShellModel &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="CoreShellCylinderModel" href="CoreShellCylinderModel.html" />
28    <link rel="prev" title="CoreFourShellModel" href="CoreFourShellModel.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="CoreShellCylinderModel.html" title="CoreShellCylinderModel"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="CoreFourShellModel.html" title="CoreFourShellModel"
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="coremultishellmodel">
57<h1>CoreMultiShellModel<a class="headerlink" href="#coremultishellmodel" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.models.CoreMultiShellModel">
59<span id="sans-models-coremultishellmodel"></span><h2><a class="reference internal" href="#module-sans.models.CoreMultiShellModel" title="sans.models.CoreMultiShellModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.CoreMultiShellModel</span></tt></a><a class="headerlink" href="#module-sans.models.CoreMultiShellModel" title="Permalink to this headline">¶</a></h2>
60<dl class="class">
61<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel">
62<em class="property">class </em><tt class="descclassname">sans.models.CoreMultiShellModel.</tt><tt class="descname">CoreMultiShellModel</tt><big>(</big><em>multfactor=1</em><big>)</big><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel" title="Permalink to this definition">¶</a></dt>
63<dd><p>Bases: <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>
64<p>This multi-model is based on CoreFourShellModel and provides the capability
65of changing the number of shells between 1 and 4.</p>
66<dl class="method">
67<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel.calculate_ER">
68<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel.calculate_ER" title="Permalink to this definition">¶</a></dt>
69<dd></dd></dl>
70
71<dl class="method">
72<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel.clone">
73<tt class="descname">clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel.clone" title="Permalink to this definition">¶</a></dt>
74<dd><p>Returns a new object identical to the current object</p>
75</dd></dl>
76
77<dl class="method">
78<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel.evalDistribution">
79<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.CoreMultiShellModel.CoreMultiShellModel.evalDistribution" title="Permalink to this definition">¶</a></dt>
80<dd><p>Evaluate the model in cartesian coordinates</p>
81<p>: param x: input q[], or [qx[], qy[]]
82: return: scattering function P(q[])</p>
83</dd></dl>
84
85<dl class="method">
86<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel.getDispParamList">
87<tt class="descname">getDispParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel.getDispParamList" title="Permalink to this definition">¶</a></dt>
88<dd><p>Return a list of all available parameters for the model</p>
89</dd></dl>
90
91<dl class="method">
92<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel.getParam">
93<tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel.getParam" title="Permalink to this definition">¶</a></dt>
94<dd><p>Set the value of a model parameter</p>
95<table class="docutils field-list" frame="void" rules="none">
96<col class="field-name" />
97<col class="field-body" />
98<tbody valign="top">
99<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td>
100</tr>
101</tbody>
102</table>
103</dd></dl>
104
105<dl class="method">
106<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel.getParamList">
107<tt class="descname">getParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel.getParamList" title="Permalink to this definition">¶</a></dt>
108<dd><p>Return a list of all available parameters for the model</p>
109</dd></dl>
110
111<dl class="method">
112<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel.getParamListWithToken">
113<tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt>
114<dd></dd></dl>
115
116<dl class="method">
117<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel.getParamWithToken">
118<tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel.getParamWithToken" title="Permalink to this definition">¶</a></dt>
119<dd></dd></dl>
120
121<dl class="method">
122<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel.getProfile">
123<tt class="descname">getProfile</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel.getProfile" title="Permalink to this definition">¶</a></dt>
124<dd><p>Get SLD profile</p>
125<dl class="docutils">
126<dt>: return: (r, beta) where r is a list of radius of the transition points</dt>
127<dd>beta is a list of the corresponding SLD values</dd>
128</dl>
129<p>: Note: This works only for func_shell# = 2.</p>
130</dd></dl>
131
132<dl class="method">
133<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel.is_fittable">
134<tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel.is_fittable" title="Permalink to this definition">¶</a></dt>
135<dd><p>Check if a given parameter is fittable or not</p>
136<table class="docutils field-list" frame="void" rules="none">
137<col class="field-name" />
138<col class="field-body" />
139<tbody valign="top">
140<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td>
141</tr>
142</tbody>
143</table>
144</dd></dl>
145
146<dl class="method">
147<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel.run">
148<tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel.run" title="Permalink to this definition">¶</a></dt>
149<dd><p>Evaluate the model</p>
150<p>: param x: input q-value (float or [float, float] as [r, theta])
151: return: (DAB value)</p>
152</dd></dl>
153
154<dl class="method">
155<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel.runXY">
156<tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel.runXY" title="Permalink to this definition">¶</a></dt>
157<dd><p>Evaluate the model</p>
158<p>: param x: input q-value (float or [float, float] as [qx, qy])
159: return: DAB value</p>
160</dd></dl>
161
162<dl class="method">
163<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel.setParam">
164<tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel.setParam" title="Permalink to this definition">¶</a></dt>
165<dd><p>Set the value of a model parameter</p>
166<p>: param name: name of the parameter
167: param value: value of the parameter</p>
168</dd></dl>
169
170<dl class="method">
171<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel.setParamWithToken">
172<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.CoreMultiShellModel.CoreMultiShellModel.setParamWithToken" title="Permalink to this definition">¶</a></dt>
173<dd></dd></dl>
174
175<dl class="method">
176<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel.set_dispersion">
177<tt class="descname">set_dispersion</tt><big>(</big><em>parameter</em>, <em>dispersion</em><big>)</big><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel.set_dispersion" title="Permalink to this definition">¶</a></dt>
178<dd><p>Set the dispersion object for a model parameter</p>
179<p>: param parameter: name of the parameter [string]
180:dispersion: dispersion object of type DispersionModel</p>
181</dd></dl>
182
183</dd></dl>
184
185</div>
186</div>
187
188
189          </div>
190        </div>
191      </div>
192      <div class="sphinxsidebar">
193        <div class="sphinxsidebarwrapper">
194  <h3><a href="../index.html">Table Of Contents</a></h3>
195  <ul>
196<li><a class="reference internal" href="#">CoreMultiShellModel</a><ul>
197<li><a class="reference internal" href="#module-sans.models.CoreMultiShellModel"><tt class="docutils literal"><span class="pre">sans.models.CoreMultiShellModel</span></tt></a></li>
198</ul>
199</li>
200</ul>
201
202  <h4>Previous topic</h4>
203  <p class="topless"><a href="CoreFourShellModel.html"
204                        title="previous chapter">CoreFourShellModel</a></p>
205  <h4>Next topic</h4>
206  <p class="topless"><a href="CoreShellCylinderModel.html"
207                        title="next chapter">CoreShellCylinderModel</a></p>
208  <h3>This Page</h3>
209  <ul class="this-page-menu">
210    <li><a href="../_sources/api/CoreMultiShellModel.txt"
211           rel="nofollow">Show Source</a></li>
212  </ul>
213<div id="searchbox" style="display: none">
214  <h3>Quick search</h3>
215    <form class="search" action="../search.html" method="get">
216      <input type="text" name="q" size="18" />
217      <input type="submit" value="Go" />
218      <input type="hidden" name="check_keywords" value="yes" />
219      <input type="hidden" name="area" value="default" />
220    </form>
221    <p class="searchtip" style="font-size: 90%">
222    Enter search terms or a module, class or function name.
223    </p>
224</div>
225<script type="text/javascript">$('#searchbox').show(0);</script>
226        </div>
227      </div>
228      <div class="clearer"></div>
229    </div>
230    <div class="related">
231      <h3>Navigation</h3>
232      <ul>
233        <li class="right" style="margin-right: 10px">
234          <a href="../genindex.html" title="General Index"
235             >index</a></li>
236        <li class="right" >
237          <a href="../py-modindex.html" title="Python Module Index"
238             >modules</a> |</li>
239        <li class="right" >
240          <a href="CoreShellCylinderModel.html" title="CoreShellCylinderModel"
241             >next</a> |</li>
242        <li class="right" >
243          <a href="CoreFourShellModel.html" title="CoreFourShellModel"
244             >previous</a> |</li>
245        <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li>
246          <li><a href="index.html" >Reference</a> &raquo;</li> 
247      </ul>
248    </div>
249    <div class="footer">
250        &copy; Copyright 2010, sans group.
251      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
252    </div>
253  </body>
254</html>
Note: See TracBrowser for help on using the repository browser.