source: sasview/sansmodels/docs/sphinx/html/api/MultiplicationModel.html @ 01de557

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

edit docs for models
  • Property mode set to 100644
File size: 18.6 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>MultiplicationModel &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="MultiShellModel" href="MultiShellModel.html" />
31    <link rel="prev" title="MulComponent" href="MulComponent.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="MultiShellModel.html" title="MultiShellModel"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="MulComponent.html" title="MulComponent"
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="multiplicationmodel">
60<h1>MultiplicationModel<a class="headerlink" href="#multiplicationmodel" title="Permalink to this headline">¶</a></h1>
61<div class="section" id="sans-models-multiplicationmodel">
62<h2><a class="reference internal" href="#module-sans.models.MultiplicationModel" title="sans.models.MultiplicationModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.MultiplicationModel</span></tt></a><a class="headerlink" href="#sans-models-multiplicationmodel" title="Permalink to this headline">¶</a></h2>
63<span class="target" id="module-sans.models.MultiplicationModel"></span><dl class="class">
64<dt id="sans.models.MultiplicationModel.MultiplicationModel">
65<em class="property">class </em><tt class="descclassname">sans.models.MultiplicationModel.</tt><tt class="descname">MultiplicationModel</tt><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel" 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>Use for P(Q)*S(Q); function call must be in the order of P(Q) and then S(Q):
68The model parameters are combined from both models, P(Q) and S(Q), except 1) &#8216;effect_radius&#8217; of S(Q)
69which will be calculated from P(Q) via calculate_ER(),
70and 2) &#8216;scale&#8217; in P model which is synchronized w/ volfraction in S
71then P*S is multiplied by a new param, &#8216;scale_factor&#8217;.
72The polydispersion is applicable only to P(Q), not to S(Q).
73Note: P(Q) refers to &#8216;form factor&#8217; model while S(Q) does to &#8216;structure factor&#8217;.</p>
74<dl class="method">
75<dt id="sans.models.MultiplicationModel.MultiplicationModel.__add__">
76<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.__add__" title="Permalink to this definition">¶</a></dt>
77<dd></dd></dl>
78
79<dl class="method">
80<dt id="sans.models.MultiplicationModel.MultiplicationModel.__div__">
81<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.__div__" title="Permalink to this definition">¶</a></dt>
82<dd></dd></dl>
83
84<dl class="method">
85<dt id="sans.models.MultiplicationModel.MultiplicationModel.__init__">
86<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.__init__" title="Permalink to this definition">¶</a></dt>
87<dd></dd></dl>
88
89<dl class="attribute">
90<dt id="sans.models.MultiplicationModel.MultiplicationModel.__module__">
91<tt class="descname">__module__</tt><em class="property"> = 'sans.models.MultiplicationModel'</em><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.__module__" title="Permalink to this definition">¶</a></dt>
92<dd></dd></dl>
93
94<dl class="method">
95<dt id="sans.models.MultiplicationModel.MultiplicationModel.__mul__">
96<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.__mul__" title="Permalink to this definition">¶</a></dt>
97<dd></dd></dl>
98
99<dl class="method">
100<dt id="sans.models.MultiplicationModel.MultiplicationModel.__str__">
101<tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.__str__" title="Permalink to this definition">¶</a></dt>
102<dd><table class="docutils field-list" frame="void" rules="none">
103<col class="field-name" />
104<col class="field-body" />
105<tbody valign="top">
106<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">string representatio</td>
107</tr>
108</tbody>
109</table>
110</dd></dl>
111
112<dl class="method">
113<dt id="sans.models.MultiplicationModel.MultiplicationModel.__sub__">
114<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.__sub__" title="Permalink to this definition">¶</a></dt>
115<dd></dd></dl>
116
117<dl class="method">
118<dt id="sans.models.MultiplicationModel.MultiplicationModel._clone">
119<tt class="descname">_clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel._clone" title="Permalink to this definition">¶</a></dt>
120<dd><p>Internal utility function to copy the internal
121data members to a fresh copy.</p>
122</dd></dl>
123
124<dl class="method">
125<dt id="sans.models.MultiplicationModel.MultiplicationModel._setParamHelper">
126<tt class="descname">_setParamHelper</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel._setParamHelper" title="Permalink to this definition">¶</a></dt>
127<dd><p>Helper function to setparam</p>
128</dd></dl>
129
130<dl class="method">
131<dt id="sans.models.MultiplicationModel.MultiplicationModel._set_details">
132<tt class="descname">_set_details</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel._set_details" title="Permalink to this definition">¶</a></dt>
133<dd><p>Concatenate details of the two models to create
134this model details</p>
135</dd></dl>
136
137<dl class="method">
138<dt id="sans.models.MultiplicationModel.MultiplicationModel._set_dispersion">
139<tt class="descname">_set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel._set_dispersion" title="Permalink to this definition">¶</a></dt>
140<dd><p>combined the two models dispersions
141Polydispersion should not be applied to s_model</p>
142</dd></dl>
143
144<dl class="method">
145<dt id="sans.models.MultiplicationModel.MultiplicationModel._set_effect_radius">
146<tt class="descname">_set_effect_radius</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel._set_effect_radius" title="Permalink to this definition">¶</a></dt>
147<dd><p>Set effective radius to S(Q) model</p>
148</dd></dl>
149
150<dl class="method">
151<dt id="sans.models.MultiplicationModel.MultiplicationModel._set_fixed_params">
152<tt class="descname">_set_fixed_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel._set_fixed_params" title="Permalink to this definition">¶</a></dt>
153<dd><p>fill the self.fixed list with the p_model fixed list</p>
154</dd></dl>
155
156<dl class="method">
157<dt id="sans.models.MultiplicationModel.MultiplicationModel._set_params">
158<tt class="descname">_set_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel._set_params" title="Permalink to this definition">¶</a></dt>
159<dd><p>Concatenate the parameters of the two models to create
160this model parameters</p>
161</dd></dl>
162
163<dl class="method">
164<dt id="sans.models.MultiplicationModel.MultiplicationModel._set_scale_factor">
165<tt class="descname">_set_scale_factor</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel._set_scale_factor" title="Permalink to this definition">¶</a></dt>
166<dd><p>Set scale=volfraction to P model</p>
167</dd></dl>
168
169<dl class="method">
170<dt id="sans.models.MultiplicationModel.MultiplicationModel.calculate_ER">
171<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.calculate_ER" title="Permalink to this definition">¶</a></dt>
172<dd></dd></dl>
173
174<dl class="method">
175<dt id="sans.models.MultiplicationModel.MultiplicationModel.clone">
176<tt class="descname">clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.clone" title="Permalink to this definition">¶</a></dt>
177<dd><p>Returns a new object identical to the current object</p>
178</dd></dl>
179
180<dl class="method">
181<dt id="sans.models.MultiplicationModel.MultiplicationModel.evalDistribution">
182<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.evalDistribution" title="Permalink to this definition">¶</a></dt>
183<dd><p>Evaluate the model in cartesian coordinates
184&#64;param x: input q[], or [qx[], qy[]]
185&#64;return: scattering function P(q[])</p>
186</dd></dl>
187
188<dl class="method">
189<dt id="sans.models.MultiplicationModel.MultiplicationModel.fill_description">
190<tt class="descname">fill_description</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.fill_description" title="Permalink to this definition">¶</a></dt>
191<dd><p>Fill the description for P(Q)*S(Q)</p>
192</dd></dl>
193
194<dl class="method">
195<dt id="sans.models.MultiplicationModel.MultiplicationModel.getDispParamList">
196<tt class="descname">getDispParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.getDispParamList" title="Permalink to this definition">¶</a></dt>
197<dd><p>Return a list of all available parameters for the model</p>
198</dd></dl>
199
200<dl class="method">
201<dt id="sans.models.MultiplicationModel.MultiplicationModel.getParam">
202<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.getParam" title="Permalink to this definition">¶</a></dt>
203<dd><p>Set the value of a model parameter</p>
204<table class="docutils field-list" frame="void" rules="none">
205<col class="field-name" />
206<col class="field-body" />
207<tbody valign="top">
208<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td>
209</tr>
210</tbody>
211</table>
212</dd></dl>
213
214<dl class="method">
215<dt id="sans.models.MultiplicationModel.MultiplicationModel.getParamList">
216<tt class="descname">getParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.getParamList" title="Permalink to this definition">¶</a></dt>
217<dd><p>Return a list of all available parameters for the model</p>
218</dd></dl>
219
220<dl class="method">
221<dt id="sans.models.MultiplicationModel.MultiplicationModel.getParamListWithToken">
222<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt>
223<dd></dd></dl>
224
225<dl class="method">
226<dt id="sans.models.MultiplicationModel.MultiplicationModel.getParamWithToken">
227<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.getParamWithToken" title="Permalink to this definition">¶</a></dt>
228<dd></dd></dl>
229
230<dl class="method">
231<dt id="sans.models.MultiplicationModel.MultiplicationModel.getProfile">
232<tt class="descname">getProfile</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.getProfile" title="Permalink to this definition">¶</a></dt>
233<dd><p>Get SLD profile of p_model if exists</p>
234<dl class="docutils">
235<dt>: return: (r, beta) where r is a list of radius of the transition points</dt>
236<dd>beta is a list of the corresponding SLD values</dd>
237</dl>
238<p>: Note: This works only for func_shell# = 2 (exp function).</p>
239</dd></dl>
240
241<dl class="method">
242<dt id="sans.models.MultiplicationModel.MultiplicationModel.is_fittable">
243<tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.is_fittable" title="Permalink to this definition">¶</a></dt>
244<dd><p>Check if a given parameter is fittable or not</p>
245<table class="docutils field-list" frame="void" rules="none">
246<col class="field-name" />
247<col class="field-body" />
248<tbody valign="top">
249<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>
250</tr>
251</tbody>
252</table>
253</dd></dl>
254
255<dl class="method">
256<dt id="sans.models.MultiplicationModel.MultiplicationModel.run">
257<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.run" title="Permalink to this definition">¶</a></dt>
258<dd><p>Evaluate the model
259&#64;param x: input q-value (float or [float, float] as [r, theta])
260&#64;return: (scattering function value)</p>
261</dd></dl>
262
263<dl class="method">
264<dt id="sans.models.MultiplicationModel.MultiplicationModel.runXY">
265<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.runXY" title="Permalink to this definition">¶</a></dt>
266<dd><p>Evaluate the model
267&#64;param x: input q-value (float or [float, float] as [qx, qy])
268&#64;return: scattering function value</p>
269</dd></dl>
270
271<dl class="method">
272<dt id="sans.models.MultiplicationModel.MultiplicationModel.setParam">
273<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.setParam" title="Permalink to this definition">¶</a></dt>
274<dd><p>Set the value of a model parameter</p>
275<p>&#64;param name: name of the parameter
276&#64;param value: value of the parameter</p>
277</dd></dl>
278
279<dl class="method">
280<dt id="sans.models.MultiplicationModel.MultiplicationModel.setParamWithToken">
281<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.setParamWithToken" title="Permalink to this definition">¶</a></dt>
282<dd></dd></dl>
283
284<dl class="method">
285<dt id="sans.models.MultiplicationModel.MultiplicationModel.set_dispersion">
286<tt class="descname">set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.MultiplicationModel.MultiplicationModel.set_dispersion" title="Permalink to this definition">¶</a></dt>
287<dd><p>Set the dispersion object for a model parameter
288&#64;param parameter: name of the parameter [string]
289&#64;dispersion: dispersion object of type DispersionModel</p>
290</dd></dl>
291
292</dd></dl>
293
294</div>
295</div>
296
297
298          </div>
299        </div>
300      </div>
301      <div class="sphinxsidebar">
302        <div class="sphinxsidebarwrapper">
303  <h3><a href="../index.html">Table Of Contents</a></h3>
304  <ul>
305<li><a class="reference internal" href="#">MultiplicationModel</a><ul>
306<li><a class="reference internal" href="#sans-models-multiplicationmodel"><tt class="docutils literal"><span class="pre">sans.models.MultiplicationModel</span></tt></a></li>
307</ul>
308</li>
309</ul>
310
311  <h4>Previous topic</h4>
312  <p class="topless"><a href="MulComponent.html"
313                        title="previous chapter">MulComponent</a></p>
314  <h4>Next topic</h4>
315  <p class="topless"><a href="MultiShellModel.html"
316                        title="next chapter">MultiShellModel</a></p>
317  <h3>This Page</h3>
318  <ul class="this-page-menu">
319    <li><a href="../_sources/api/MultiplicationModel.txt"
320           rel="nofollow">Show Source</a></li>
321  </ul>
322<div id="searchbox" style="display: none">
323  <h3>Quick search</h3>
324    <form class="search" action="../search.html" method="get">
325      <input type="text" name="q" />
326      <input type="submit" value="Go" />
327      <input type="hidden" name="check_keywords" value="yes" />
328      <input type="hidden" name="area" value="default" />
329    </form>
330    <p class="searchtip" style="font-size: 90%">
331    Enter search terms or a module, class or function name.
332    </p>
333</div>
334<script type="text/javascript">$('#searchbox').show(0);</script>
335        </div>
336      </div>
337      <div class="clearer"></div>
338    </div>
339    <div class="related">
340      <h3>Navigation</h3>
341      <ul>
342        <li class="right" style="margin-right: 10px">
343          <a href="../genindex.html" title="General Index"
344             >index</a></li>
345        <li class="right" >
346          <a href="../py-modindex.html" title="Python Module Index"
347             >modules</a> |</li>
348        <li class="right" >
349          <a href="MultiShellModel.html" title="MultiShellModel"
350             >next</a> |</li>
351        <li class="right" >
352          <a href="MulComponent.html" title="MulComponent"
353             >previous</a> |</li>
354        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li>
355          <li><a href="index.html" >Reference</a> &raquo;</li> 
356      </ul>
357    </div>
358    <div class="footer">
359        &copy; Copyright 2010, sans group.
360      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
361    </div>
362  </body>
363</html>
Note: See TracBrowser for help on using the repository browser.