source: sasview/sansmodels/docs/sphinx/html/api/MultiplicationModel.html @ 017e0390

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

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