source: sasview/sansmodels/docs/sphinx/html/api/CoreMultiShellModel.html @ 8d70c0a

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

edit docs for models
  • Property mode set to 100644
File size: 17.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
7<html xmlns="http://www.w3.org/1999/xhtml">
8  <head>
9    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10   
11    <title>CoreMultiShellModel &mdash; sansmodels 0.1.0 documentation</title>
12   
13    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
14    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
15   
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>
28    <link rel="top" title="sansmodels 0.1.0 documentation" href="../index.html" />
29    <link rel="up" title="Reference" href="index.html" />
30    <link rel="next" title="CoreShellCylinderModel" href="CoreShellCylinderModel.html" />
31    <link rel="prev" title="CoreFourShellModel" href="CoreFourShellModel.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="CoreShellCylinderModel.html" title="CoreShellCylinderModel"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="CoreFourShellModel.html" title="CoreFourShellModel"
48             accesskey="P">previous</a> |</li>
49        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li>
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="coremultishellmodel">
60<h1>CoreMultiShellModel<a class="headerlink" href="#coremultishellmodel" title="Permalink to this headline">¶</a></h1>
61<div class="section" id="sans-models-coremultishellmodel">
62<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="#sans-models-coremultishellmodel" title="Permalink to this headline">¶</a></h2>
63<span class="target" id="module-sans.models.CoreMultiShellModel"></span><dl class="class">
64<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel">
65<em class="property">class </em><tt class="descclassname">sans.models.CoreMultiShellModel.</tt><tt class="descname">CoreMultiShellModel</tt><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel" title="Permalink to this definition">¶</a></dt>
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 CoreFourShellModel and provides the capability
68of changing the number of shells between 1 and 4.</p>
69<dl class="method">
70<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel.__add__">
71<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel.__add__" title="Permalink to this definition">¶</a></dt>
72<dd></dd></dl>
73
74<dl class="method">
75<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel.__div__">
76<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel.__div__" title="Permalink to this definition">¶</a></dt>
77<dd></dd></dl>
78
79<dl class="method">
80<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel.__init__">
81<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel.__init__" title="Permalink to this definition">¶</a></dt>
82<dd></dd></dl>
83
84<dl class="attribute">
85<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel.__module__">
86<tt class="descname">__module__</tt><em class="property"> = 'sans.models.CoreMultiShellModel'</em><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel.__module__" title="Permalink to this definition">¶</a></dt>
87<dd></dd></dl>
88
89<dl class="method">
90<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel.__mul__">
91<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel.__mul__" title="Permalink to this definition">¶</a></dt>
92<dd></dd></dl>
93
94<dl class="method">
95<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel.__str__">
96<tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel.__str__" title="Permalink to this definition">¶</a></dt>
97<dd><table class="docutils field-list" frame="void" rules="none">
98<col class="field-name" />
99<col class="field-body" />
100<tbody valign="top">
101<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">string representatio</td>
102</tr>
103</tbody>
104</table>
105</dd></dl>
106
107<dl class="method">
108<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel.__sub__">
109<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel.__sub__" title="Permalink to this definition">¶</a></dt>
110<dd></dd></dl>
111
112<dl class="method">
113<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel._clone">
114<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>
115<dd><p>Internal utility function to copy the internal
116data members to a fresh copy.</p>
117</dd></dl>
118
119<dl class="method">
120<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel._setParamHelper">
121<tt class="descname">_setParamHelper</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel._setParamHelper" title="Permalink to this definition">¶</a></dt>
122<dd><p>Helper function to setParam</p>
123</dd></dl>
124
125<dl class="method">
126<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel._set_details">
127<tt class="descname">_set_details</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel._set_details" title="Permalink to this definition">¶</a></dt>
128<dd><p>Concatenate details of the original model to create
129this model details</p>
130</dd></dl>
131
132<dl class="method">
133<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel._set_dispersion">
134<tt class="descname">_set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel._set_dispersion" title="Permalink to this definition">¶</a></dt>
135<dd><p>model dispersions
136Polydispersion should not be applied to s_model</p>
137</dd></dl>
138
139<dl class="method">
140<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel._set_fixed_params">
141<tt class="descname">_set_fixed_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel._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.CoreMultiShellModel.CoreMultiShellModel._set_params">
147<tt class="descname">_set_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel._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.CoreMultiShellModel.CoreMultiShellModel._set_xtra_model_param">
154<tt class="descname">_set_xtra_model_param</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel._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">
159<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel.calculate_ER">
160<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>
161<dd></dd></dl>
162
163<dl class="method">
164<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel.clone">
165<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>
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.CoreMultiShellModel.CoreMultiShellModel.evalDistribution">
171<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel.evalDistribution" title="Permalink to this definition">¶</a></dt>
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.CoreMultiShellModel.CoreMultiShellModel.getDispParamList">
179<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>
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.CoreMultiShellModel.CoreMultiShellModel.getParam">
185<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel.getParam" title="Permalink to this definition">¶</a></dt>
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">
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>
192</tr>
193</tbody>
194</table>
195</dd></dl>
196
197<dl class="method">
198<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel.getParamList">
199<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>
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.CoreMultiShellModel.CoreMultiShellModel.getParamListWithToken">
205<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt>
206<dd></dd></dl>
207
208<dl class="method">
209<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel.getParamWithToken">
210<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel.getParamWithToken" title="Permalink to this definition">¶</a></dt>
211<dd></dd></dl>
212
213<dl class="method">
214<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel.getProfile">
215<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>
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 points</dt>
219<dd>beta is a list of the corresponding SLD values</dd>
220</dl>
221<p>: Note: This works only for func_shell# = 2.</p>
222</dd></dl>
223
224<dl class="method">
225<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel.is_fittable">
226<tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel.is_fittable" title="Permalink to this definition">¶</a></dt>
227<dd><p>Check if a given parameter is fittable or not</p>
228<table class="docutils field-list" frame="void" rules="none">
229<col class="field-name" />
230<col class="field-body" />
231<tbody valign="top">
232<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>
233</tr>
234</tbody>
235</table>
236</dd></dl>
237
238<dl class="method">
239<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel.run">
240<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel.run" title="Permalink to this definition">¶</a></dt>
241<dd><p>Evaluate the model</p>
242<p>: param x: input q-value (float or [float, float] as [r, theta])
243: return: (DAB value)</p>
244</dd></dl>
245
246<dl class="method">
247<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel.runXY">
248<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel.runXY" title="Permalink to this definition">¶</a></dt>
249<dd><p>Evaluate the model</p>
250<p>: param x: input q-value (float or [float, float] as [qx, qy])
251: return: DAB value</p>
252</dd></dl>
253
254<dl class="method">
255<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel.setParam">
256<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel.setParam" title="Permalink to this definition">¶</a></dt>
257<dd><p>Set the value of a model parameter</p>
258<p>: param name: name of the parameter
259: param value: value of the parameter</p>
260</dd></dl>
261
262<dl class="method">
263<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel.setParamWithToken">
264<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel.setParamWithToken" title="Permalink to this definition">¶</a></dt>
265<dd></dd></dl>
266
267<dl class="method">
268<dt id="sans.models.CoreMultiShellModel.CoreMultiShellModel.set_dispersion">
269<tt class="descname">set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.CoreMultiShellModel.CoreMultiShellModel.set_dispersion" title="Permalink to this definition">¶</a></dt>
270<dd><p>Set the dispersion object for a model parameter</p>
271<p>: param parameter: name of the parameter [string]
272:dispersion: dispersion object of type DispersionModel</p>
273</dd></dl>
274
275</dd></dl>
276
277</div>
278</div>
279
280
281          </div>
282        </div>
283      </div>
284      <div class="sphinxsidebar">
285        <div class="sphinxsidebarwrapper">
286  <h3><a href="../index.html">Table Of Contents</a></h3>
287  <ul>
288<li><a class="reference internal" href="#">CoreMultiShellModel</a><ul>
289<li><a class="reference internal" href="#sans-models-coremultishellmodel"><tt class="docutils literal"><span class="pre">sans.models.CoreMultiShellModel</span></tt></a></li>
290</ul>
291</li>
292</ul>
293
294  <h4>Previous topic</h4>
295  <p class="topless"><a href="CoreFourShellModel.html"
296                        title="previous chapter">CoreFourShellModel</a></p>
297  <h4>Next topic</h4>
298  <p class="topless"><a href="CoreShellCylinderModel.html"
299                        title="next chapter">CoreShellCylinderModel</a></p>
300  <h3>This Page</h3>
301  <ul class="this-page-menu">
302    <li><a href="../_sources/api/CoreMultiShellModel.txt"
303           rel="nofollow">Show Source</a></li>
304  </ul>
305<div id="searchbox" style="display: none">
306  <h3>Quick search</h3>
307    <form class="search" action="../search.html" method="get">
308      <input type="text" name="q" />
309      <input type="submit" value="Go" />
310      <input type="hidden" name="check_keywords" value="yes" />
311      <input type="hidden" name="area" value="default" />
312    </form>
313    <p class="searchtip" style="font-size: 90%">
314    Enter search terms or a module, class or function name.
315    </p>
316</div>
317<script type="text/javascript">$('#searchbox').show(0);</script>
318        </div>
319      </div>
320      <div class="clearer"></div>
321    </div>
322    <div class="related">
323      <h3>Navigation</h3>
324      <ul>
325        <li class="right" style="margin-right: 10px">
326          <a href="../genindex.html" title="General Index"
327             >index</a></li>
328        <li class="right" >
329          <a href="../py-modindex.html" title="Python Module Index"
330             >modules</a> |</li>
331        <li class="right" >
332          <a href="CoreShellCylinderModel.html" title="CoreShellCylinderModel"
333             >next</a> |</li>
334        <li class="right" >
335          <a href="CoreFourShellModel.html" title="CoreFourShellModel"
336             >previous</a> |</li>
337        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li>
338          <li><a href="index.html" >Reference</a> &raquo;</li> 
339      </ul>
340    </div>
341    <div class="footer">
342        &copy; Copyright 2010, sans group.
343      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
344    </div>
345  </body>
346</html>
Note: See TracBrowser for help on using the repository browser.