source: sasview/sansmodels/docs/sphinx/_build/html/api/MultiplicationModel.html @ 79ac6f8

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 79ac6f8 was 79ac6f8, checked in by Gervaise Alina <gervyh@…>, 15 years ago

working on documentation
  • Property mode set to 100644
File size: 13.0 KB
RevLine 
[79ac6f8]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"><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>Returns a new object identical to the current object</dd></dl>
80
81<dl class="method">
82<dt id="sans.models.MultiplicationModel.MultiplicationModel.evalDistribution">
83<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>
84<dd>Evaluate the model in cartesian coordinates
85&#64;param x: input q[], or [qx[], qy[]]
86&#64;return: scattering function P(q[])</dd></dl>
87
88<dl class="method">
89<dt id="sans.models.MultiplicationModel.MultiplicationModel.fill_description">
90<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>
91<dd>Fill the description for P(Q)*S(Q)</dd></dl>
92
93<dl class="method">
94<dt id="sans.models.MultiplicationModel.MultiplicationModel.getDispParamList">
95<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>
96<dd>Return a list of all available parameters for the model</dd></dl>
97
98<dl class="method">
99<dt id="sans.models.MultiplicationModel.MultiplicationModel.getParam">
100<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>
101<dd><p>Set the value of a model parameter</p>
102<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"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
107<li><strong>name</strong> &#8211; name of the parameter</li>
108</ul>
109</td>
110</tr>
111</tbody>
112</table>
113</dd></dl>
114
115<dl class="method">
116<dt id="sans.models.MultiplicationModel.MultiplicationModel.getParamList">
117<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>
118<dd>Return a list of all available parameters for the model</dd></dl>
119
120<dl class="method">
121<dt id="sans.models.MultiplicationModel.MultiplicationModel.getParamListWithToken">
122<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>
123<dd></dd></dl>
124
125<dl class="method">
126<dt id="sans.models.MultiplicationModel.MultiplicationModel.getParamWithToken">
127<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>
128<dd></dd></dl>
129
130<dl class="method">
131<dt id="sans.models.MultiplicationModel.MultiplicationModel.is_fittable">
132<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>
133<dd><p>Check if a given parameter is fittable or not</p>
134<table class="docutils field-list" frame="void" rules="none">
135<col class="field-name" />
136<col class="field-body" />
137<tbody valign="top">
138<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
139<li><strong>par_name</strong> &#8211; the parameter name to check</li>
140</ul>
141</td>
142</tr>
143</tbody>
144</table>
145</dd></dl>
146
147<dl class="method">
148<dt id="sans.models.MultiplicationModel.MultiplicationModel.run">
149<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>
150<dd>Evaluate the model
151&#64;param x: input q-value (float or [float, float] as [r, theta])
152&#64;return: (DAB value)</dd></dl>
153
154<dl class="method">
155<dt id="sans.models.MultiplicationModel.MultiplicationModel.runXY">
156<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>
157<dd>Evaluate the model
158&#64;param x: input q-value (float or [float, float] as [qx, qy])
159&#64;return: DAB value</dd></dl>
160
161<dl class="method">
162<dt id="sans.models.MultiplicationModel.MultiplicationModel.setParam">
163<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>
164<dd><p>Set the value of a model parameter</p>
165<p>&#64;param name: name of the parameter
166&#64;param value: value of the parameter</p>
167</dd></dl>
168
169<dl class="method">
170<dt id="sans.models.MultiplicationModel.MultiplicationModel.setParamWithToken">
171<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>
172<dd></dd></dl>
173
174<dl class="method">
175<dt id="sans.models.MultiplicationModel.MultiplicationModel.set_dispersion">
176<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>
177<dd>Set the dispersion object for a model parameter
178&#64;param parameter: name of the parameter [string]
179&#64;dispersion: dispersion object of type DispersionModel</dd></dl>
180
181</dd></dl>
182
183</div>
184</div>
185
186
187          </div>
188        </div>
189      </div>
190      <div class="sphinxsidebar">
191        <div class="sphinxsidebarwrapper">
192  <h3><a href="../index.html">Table Of Contents</a></h3>
193  <ul>
194<li><a class="reference internal" href="#">MultiplicationModel</a><ul>
195<li><a class="reference internal" href="#module-sans.models.MultiplicationModel"><tt class="docutils literal"><span class="pre">sans.models.MultiplicationModel</span></tt></a></li>
196</ul>
197</li>
198</ul>
199
200  <h4>Previous topic</h4>
201  <p class="topless"><a href="MulComponent.html"
202                        title="previous chapter">MulComponent</a></p>
203  <h4>Next topic</h4>
204  <p class="topless"><a href="MultiShellModel.html"
205                        title="next chapter">MultiShellModel</a></p>
206  <h3>This Page</h3>
207  <ul class="this-page-menu">
208    <li><a href="../_sources/api/MultiplicationModel.txt"
209           rel="nofollow">Show Source</a></li>
210  </ul>
211<div id="searchbox" style="display: none">
212  <h3>Quick search</h3>
213    <form class="search" action="../search.html" method="get">
214      <input type="text" name="q" size="18" />
215      <input type="submit" value="Go" />
216      <input type="hidden" name="check_keywords" value="yes" />
217      <input type="hidden" name="area" value="default" />
218    </form>
219    <p class="searchtip" style="font-size: 90%">
220    Enter search terms or a module, class or function name.
221    </p>
222</div>
223<script type="text/javascript">$('#searchbox').show(0);</script>
224        </div>
225      </div>
226      <div class="clearer"></div>
227    </div>
228    <div class="related">
229      <h3>Navigation</h3>
230      <ul>
231        <li class="right" style="margin-right: 10px">
232          <a href="../genindex.html" title="General Index"
233             >index</a></li>
234        <li class="right" >
235          <a href="../py-modindex.html" title="Python Module Index"
236             >modules</a> |</li>
237        <li class="right" >
238          <a href="MultiShellModel.html" title="MultiShellModel"
239             >next</a> |</li>
240        <li class="right" >
241          <a href="MulComponent.html" title="MulComponent"
242             >previous</a> |</li>
243        <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li>
244          <li><a href="index.html" >Reference</a> &raquo;</li> 
245      </ul>
246    </div>
247    <div class="footer">
248        &copy; Copyright 2010, sans group.
249      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0b1.
250    </div>
251  </body>
252</html>
Note: See TracBrowser for help on using the repository browser.