source: sasview/sansmodels/docs/sphinx/html/api/OnionExpShellModel.html @ c09ace41

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 c09ace41 was c0d873f, checked in by Gervaise Alina <gervyh@…>, 13 years ago

edit docs for models
  • Property mode set to 100644
File size: 17.1 KB
RevLine 
[512573a]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
[c0d873f]6
[512573a]7<html xmlns="http://www.w3.org/1999/xhtml">
8  <head>
9    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10   
[c0d873f]11    <title>OnionExpShellModel &mdash; sansmodels 0.1.0 documentation</title>
12   
[512573a]13    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
14    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
[c0d873f]15   
[512573a]16    <script type="text/javascript">
17      var DOCUMENTATION_OPTIONS = {
18        URL_ROOT:    '../',
19        VERSION:     '0.1.0',
20        COLLAPSE_INDEX: false,
21        FILE_SUFFIX: '.html',
22        HAS_SOURCE:  true
23      };
24    </script>
25    <script type="text/javascript" src="../_static/jquery.js"></script>
26    <script type="text/javascript" src="../_static/underscore.js"></script>
27    <script type="text/javascript" src="../_static/doctools.js"></script>
[c0d873f]28    <link rel="top" title="sansmodels 0.1.0 documentation" href="../index.html" />
[512573a]29    <link rel="up" title="Reference" href="index.html" />
30    <link rel="next" title="OnionModel" href="OnionModel.html" />
31    <link rel="prev" title="OblateModel" href="OblateModel.html" /> 
32  </head>
33  <body>
34    <div class="related">
35      <h3>Navigation</h3>
36      <ul>
37        <li class="right" style="margin-right: 10px">
38          <a href="../genindex.html" title="General Index"
39             accesskey="I">index</a></li>
40        <li class="right" >
41          <a href="../py-modindex.html" title="Python Module Index"
42             >modules</a> |</li>
43        <li class="right" >
44          <a href="OnionModel.html" title="OnionModel"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="OblateModel.html" title="OblateModel"
48             accesskey="P">previous</a> |</li>
[c0d873f]49        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li>
[512573a]50          <li><a href="index.html" accesskey="U">Reference</a> &raquo;</li> 
51      </ul>
52    </div> 
53
54    <div class="document">
55      <div class="documentwrapper">
56        <div class="bodywrapper">
57          <div class="body">
58           
59  <div class="section" id="onionexpshellmodel">
60<h1>OnionExpShellModel<a class="headerlink" href="#onionexpshellmodel" title="Permalink to this headline">¶</a></h1>
[c0d873f]61<div class="section" id="sans-models-onionexpshellmodel">
62<h2><a class="reference internal" href="#module-sans.models.OnionExpShellModel" title="sans.models.OnionExpShellModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.OnionExpShellModel</span></tt></a><a class="headerlink" href="#sans-models-onionexpshellmodel" title="Permalink to this headline">¶</a></h2>
63<span class="target" id="module-sans.models.OnionExpShellModel"></span><dl class="class">
[512573a]64<dt id="sans.models.OnionExpShellModel.OnionExpShellModel">
[c0d873f]65<em class="property">class </em><tt class="descclassname">sans.models.OnionExpShellModel.</tt><tt class="descname">OnionExpShellModel</tt><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel" title="Permalink to this definition">¶</a></dt>
[512573a]66<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>
67<p>This multi-model is based on CoreMultiShellModel with exponential
68func shells and provides the capability
69of changing the number of shells between 1 and 10.</p>
70<dl class="method">
[c0d873f]71<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.__add__">
72<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.__add__" title="Permalink to this definition">¶</a></dt>
73<dd></dd></dl>
74
75<dl class="method">
76<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.__div__">
77<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.__div__" title="Permalink to this definition">¶</a></dt>
78<dd></dd></dl>
79
80<dl class="method">
81<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.__init__">
82<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.__init__" title="Permalink to this definition">¶</a></dt>
83<dd></dd></dl>
84
85<dl class="attribute">
86<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.__module__">
87<tt class="descname">__module__</tt><em class="property"> = 'sans.models.OnionExpShellModel'</em><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.__module__" title="Permalink to this definition">¶</a></dt>
88<dd></dd></dl>
89
90<dl class="method">
91<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.__mul__">
92<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.__mul__" title="Permalink to this definition">¶</a></dt>
93<dd></dd></dl>
94
95<dl class="method">
96<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.__str__">
97<tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.__str__" title="Permalink to this definition">¶</a></dt>
98<dd><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-odd field"><th class="field-name">Returns:</th><td class="field-body">string representatio</td>
103</tr>
104</tbody>
105</table>
106</dd></dl>
107
108<dl class="method">
109<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.__sub__">
110<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.__sub__" title="Permalink to this definition">¶</a></dt>
111<dd></dd></dl>
112
113<dl class="method">
114<dt id="sans.models.OnionExpShellModel.OnionExpShellModel._clone">
115<tt class="descname">_clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel._clone" title="Permalink to this definition">¶</a></dt>
116<dd><p>Internal utility function to copy the internal
117data members to a fresh copy.</p>
118</dd></dl>
119
120<dl class="method">
121<dt id="sans.models.OnionExpShellModel.OnionExpShellModel._setParamHelper">
122<tt class="descname">_setParamHelper</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel._setParamHelper" title="Permalink to this definition">¶</a></dt>
123<dd><p>Helper function to setParam</p>
124</dd></dl>
125
126<dl class="method">
127<dt id="sans.models.OnionExpShellModel.OnionExpShellModel._set_details">
128<tt class="descname">_set_details</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel._set_details" title="Permalink to this definition">¶</a></dt>
129<dd><p>Concatenate details of the original model to create
130this model details</p>
131</dd></dl>
132
133<dl class="method">
134<dt id="sans.models.OnionExpShellModel.OnionExpShellModel._set_dispersion">
135<tt class="descname">_set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel._set_dispersion" title="Permalink to this definition">¶</a></dt>
136<dd><p>model dispersions</p>
137</dd></dl>
138
139<dl class="method">
140<dt id="sans.models.OnionExpShellModel.OnionExpShellModel._set_fixed_params">
141<tt class="descname">_set_fixed_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel._set_fixed_params" title="Permalink to this definition">¶</a></dt>
142<dd><p>Fill the self.fixed list with the model fixed list</p>
143</dd></dl>
144
145<dl class="method">
146<dt id="sans.models.OnionExpShellModel.OnionExpShellModel._set_params">
147<tt class="descname">_set_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel._set_params" title="Permalink to this definition">¶</a></dt>
148<dd><p>Concatenate the parameters of the model to create
149this model parameters</p>
150</dd></dl>
151
152<dl class="method">
153<dt id="sans.models.OnionExpShellModel.OnionExpShellModel._set_xtra_model_param">
154<tt class="descname">_set_xtra_model_param</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel._set_xtra_model_param" title="Permalink to this definition">¶</a></dt>
155<dd><p>Set params of original model that are hidden from this model</p>
156</dd></dl>
157
158<dl class="method">
[512573a]159<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.calculate_ER">
160<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.calculate_ER" title="Permalink to this definition">¶</a></dt>
161<dd></dd></dl>
162
163<dl class="method">
164<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.clone">
165<tt class="descname">clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.clone" title="Permalink to this definition">¶</a></dt>
166<dd><p>Returns a new object identical to the current object</p>
167</dd></dl>
168
169<dl class="method">
170<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.evalDistribution">
[c0d873f]171<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.evalDistribution" title="Permalink to this definition">¶</a></dt>
[512573a]172<dd><p>Evaluate the model in cartesian coordinates</p>
173<p>: param x: input q[], or [qx[], qy[]]
174: return: scattering function P(q[])</p>
175</dd></dl>
176
177<dl class="method">
178<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.getDispParamList">
179<tt class="descname">getDispParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.getDispParamList" title="Permalink to this definition">¶</a></dt>
180<dd><p>Return a list of all available parameters for the model</p>
181</dd></dl>
182
183<dl class="method">
184<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.getParam">
[c0d873f]185<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.getParam" title="Permalink to this definition">¶</a></dt>
[512573a]186<dd><p>Set the value of a model parameter</p>
187<table class="docutils field-list" frame="void" rules="none">
188<col class="field-name" />
189<col class="field-body" />
190<tbody valign="top">
[c0d873f]191<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td>
[512573a]192</tr>
193</tbody>
194</table>
195</dd></dl>
196
197<dl class="method">
198<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.getParamList">
199<tt class="descname">getParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.getParamList" title="Permalink to this definition">¶</a></dt>
200<dd><p>Return a list of all available parameters for the model</p>
201</dd></dl>
202
203<dl class="method">
204<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.getParamListWithToken">
[c0d873f]205<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt>
[512573a]206<dd></dd></dl>
207
208<dl class="method">
209<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.getParamWithToken">
[c0d873f]210<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.getParamWithToken" title="Permalink to this definition">¶</a></dt>
[512573a]211<dd></dd></dl>
212
213<dl class="method">
214<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.getProfile">
215<tt class="descname">getProfile</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.getProfile" title="Permalink to this definition">¶</a></dt>
216<dd><p>Get SLD profile</p>
217<dl class="docutils">
218<dt>: return: (r, beta) where r is a list of radius of the transition </dt>
219<dd>points and  beta is a list of the corresponding SLD values</dd>
220</dl>
221</dd></dl>
222
223<dl class="method">
224<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.is_fittable">
[c0d873f]225<tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.is_fittable" title="Permalink to this definition">¶</a></dt>
[512573a]226<dd><p>Check if a given parameter is fittable or not</p>
227<table class="docutils field-list" frame="void" rules="none">
228<col class="field-name" />
229<col class="field-body" />
230<tbody valign="top">
[c0d873f]231<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td>
[512573a]232</tr>
233</tbody>
234</table>
235</dd></dl>
236
237<dl class="method">
238<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.run">
[c0d873f]239<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.run" title="Permalink to this definition">¶</a></dt>
[512573a]240<dd><p>Evaluate the model</p>
241<p>: param x: input q-value (float or [float, float] as [r, theta])
242: return: (I value)</p>
243</dd></dl>
244
245<dl class="method">
246<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.runXY">
[c0d873f]247<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.runXY" title="Permalink to this definition">¶</a></dt>
[512573a]248<dd><p>Evaluate the model</p>
249<p>: param x: input q-value (float or [float, float] as [qx, qy])
250: return: I value</p>
251</dd></dl>
252
253<dl class="method">
254<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.setParam">
[c0d873f]255<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.setParam" title="Permalink to this definition">¶</a></dt>
[512573a]256<dd><p>Set the value of a model parameter</p>
257<p>: param name: name of the parameter
258: param value: value of the parameter</p>
259</dd></dl>
260
261<dl class="method">
262<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.setParamWithToken">
[c0d873f]263<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.setParamWithToken" title="Permalink to this definition">¶</a></dt>
[512573a]264<dd></dd></dl>
265
266<dl class="method">
267<dt id="sans.models.OnionExpShellModel.OnionExpShellModel.set_dispersion">
[c0d873f]268<tt class="descname">set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.OnionExpShellModel.OnionExpShellModel.set_dispersion" title="Permalink to this definition">¶</a></dt>
[512573a]269<dd><p>Set the dispersion object for a model parameter</p>
270<p>: param parameter: name of the parameter [string]
271:dispersion: dispersion object of type DispersionModel</p>
272</dd></dl>
273
274</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="#">OnionExpShellModel</a><ul>
[c0d873f]288<li><a class="reference internal" href="#sans-models-onionexpshellmodel"><tt class="docutils literal"><span class="pre">sans.models.OnionExpShellModel</span></tt></a></li>
[512573a]289</ul>
290</li>
291</ul>
292
293  <h4>Previous topic</h4>
294  <p class="topless"><a href="OblateModel.html"
295                        title="previous chapter">OblateModel</a></p>
296  <h4>Next topic</h4>
297  <p class="topless"><a href="OnionModel.html"
298                        title="next chapter">OnionModel</a></p>
299  <h3>This Page</h3>
300  <ul class="this-page-menu">
301    <li><a href="../_sources/api/OnionExpShellModel.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">
[c0d873f]307      <input type="text" name="q" />
[512573a]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="OnionModel.html" title="OnionModel"
332             >next</a> |</li>
333        <li class="right" >
334          <a href="OblateModel.html" title="OblateModel"
335             >previous</a> |</li>
[c0d873f]336        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li>
[512573a]337          <li><a href="index.html" >Reference</a> &raquo;</li> 
338      </ul>
339    </div>
340    <div class="footer">
341        &copy; Copyright 2010, sans group.
[c0d873f]342      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
[512573a]343    </div>
344  </body>
345</html>
Note: See TracBrowser for help on using the repository browser.