source: sasview/sansmodels/docs/sphinx/html/api/ReflectivityIIModel.html @ e594bb0

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 e594bb0 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>ReflectivityIIModel &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="ReflectivityModel" href="ReflectivityModel.html" />
31    <link rel="prev" title="ReflAdvModel" href="ReflAdvModel.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="ReflectivityModel.html" title="ReflectivityModel"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="ReflAdvModel.html" title="ReflAdvModel"
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="reflectivityiimodel">
60<h1>ReflectivityIIModel<a class="headerlink" href="#reflectivityiimodel" title="Permalink to this headline">¶</a></h1>
61<div class="section" id="sans-models-reflectivityiimodel">
62<h2><a class="reference internal" href="#module-sans.models.ReflectivityIIModel" title="sans.models.ReflectivityIIModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.ReflectivityIIModel</span></tt></a><a class="headerlink" href="#sans-models-reflectivityiimodel" title="Permalink to this headline">¶</a></h2>
63<span class="target" id="module-sans.models.ReflectivityIIModel"></span><dl class="class">
64<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel">
65<em class="property">class </em><tt class="descclassname">sans.models.ReflectivityIIModel.</tt><tt class="descname">ReflectivityIIModel</tt><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel" 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 Parratt formalism and provides the capability
68of changing the number of layers between 0 and 10.</p>
69<dl class="method">
70<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel.__add__">
71<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.__add__" title="Permalink to this definition">¶</a></dt>
72<dd></dd></dl>
73
74<dl class="method">
75<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel.__div__">
76<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.__div__" title="Permalink to this definition">¶</a></dt>
77<dd></dd></dl>
78
79<dl class="method">
80<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel.__init__">
81<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.__init__" title="Permalink to this definition">¶</a></dt>
82<dd></dd></dl>
83
84<dl class="attribute">
85<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel.__module__">
86<tt class="descname">__module__</tt><em class="property"> = 'sans.models.ReflectivityIIModel'</em><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.__module__" title="Permalink to this definition">¶</a></dt>
87<dd></dd></dl>
88
89<dl class="method">
90<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel.__mul__">
91<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.__mul__" title="Permalink to this definition">¶</a></dt>
92<dd></dd></dl>
93
94<dl class="method">
95<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel.__str__">
96<tt class="descname">__str__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.__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.ReflectivityIIModel.ReflectivityIIModel.__sub__">
109<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.__sub__" title="Permalink to this definition">¶</a></dt>
110<dd></dd></dl>
111
112<dl class="method">
113<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel._clone">
114<tt class="descname">_clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel._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.ReflectivityIIModel.ReflectivityIIModel._get_func_list">
121<tt class="descname">_get_func_list</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel._get_func_list" title="Permalink to this definition">¶</a></dt>
122<dd><p>Get the list of functions in each layer (shell)</p>
123</dd></dl>
124
125<dl class="method">
126<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel._get_sld">
127<tt class="descname">_get_sld</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel._get_sld" title="Permalink to this definition">¶</a></dt>
128<dd><p>Get the function asked to build sld profile
129: param func_idx: func type number
130: param n_sub: total number of sub_layer
131: param n_s: index of sub_layer
132: param nu: coefficient of the function
133: param sld_l: sld on the left side
134: param sld_r: sld on the right side
135: return: sld value, float</p>
136</dd></dl>
137
138<dl class="method">
139<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel._setParamHelper">
140<tt class="descname">_setParamHelper</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel._setParamHelper" title="Permalink to this definition">¶</a></dt>
141<dd><p>Helper function to setParam</p>
142</dd></dl>
143
144<dl class="method">
145<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel._set_details">
146<tt class="descname">_set_details</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel._set_details" title="Permalink to this definition">¶</a></dt>
147<dd><p>Concatenate details of the original model to create
148this model details</p>
149</dd></dl>
150
151<dl class="method">
152<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel._set_dispersion">
153<tt class="descname">_set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel._set_dispersion" title="Permalink to this definition">¶</a></dt>
154<dd><p>model dispersions</p>
155</dd></dl>
156
157<dl class="method">
158<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel._set_fixed_params">
159<tt class="descname">_set_fixed_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel._set_fixed_params" title="Permalink to this definition">¶</a></dt>
160<dd><p>Fill the self.fixed list with the model fixed list</p>
161</dd></dl>
162
163<dl class="method">
164<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel._set_params">
165<tt class="descname">_set_params</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel._set_params" title="Permalink to this definition">¶</a></dt>
166<dd><p>Concatenate the parameters of the model to create
167this model parameters</p>
168</dd></dl>
169
170<dl class="method">
171<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel._set_xtra_model_param">
172<tt class="descname">_set_xtra_model_param</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel._set_xtra_model_param" title="Permalink to this definition">¶</a></dt>
173<dd><p>Set params of original model that are hidden from this model</p>
174</dd></dl>
175
176<dl class="method">
177<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel.calculate_ER">
178<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.calculate_ER" title="Permalink to this definition">¶</a></dt>
179<dd></dd></dl>
180
181<dl class="method">
182<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel.clone">
183<tt class="descname">clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.clone" title="Permalink to this definition">¶</a></dt>
184<dd><p>Returns a new object identical to the current object</p>
185</dd></dl>
186
187<dl class="method">
188<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel.evalDistribution">
189<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.evalDistribution" title="Permalink to this definition">¶</a></dt>
190<dd><p>Evaluate the model in cartesian coordinates</p>
191<p>: param x: input q[], or [qx[], qy[]]
192: return: scattering function P(q[])</p>
193</dd></dl>
194
195<dl class="method">
196<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel.getDispParamList">
197<tt class="descname">getDispParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.getDispParamList" title="Permalink to this definition">¶</a></dt>
198<dd><p>Return a list of all available parameters for the model</p>
199</dd></dl>
200
201<dl class="method">
202<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel.getParam">
203<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.getParam" title="Permalink to this definition">¶</a></dt>
204<dd><p>Set the value of a model parameter</p>
205<table class="docutils field-list" frame="void" rules="none">
206<col class="field-name" />
207<col class="field-body" />
208<tbody valign="top">
209<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td>
210</tr>
211</tbody>
212</table>
213</dd></dl>
214
215<dl class="method">
216<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel.getParamList">
217<tt class="descname">getParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.getParamList" title="Permalink to this definition">¶</a></dt>
218<dd><p>Return a list of all available parameters for the model</p>
219</dd></dl>
220
221<dl class="method">
222<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel.getParamListWithToken">
223<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt>
224<dd></dd></dl>
225
226<dl class="method">
227<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel.getParamWithToken">
228<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.getParamWithToken" title="Permalink to this definition">¶</a></dt>
229<dd></dd></dl>
230
231<dl class="method">
232<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel.getProfile">
233<tt class="descname">getProfile</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.getProfile" title="Permalink to this definition">¶</a></dt>
234<dd><p>Get SLD profile</p>
235<dl class="docutils">
236<dt>: return: (z, beta) where z is a list of depth of the transition points</dt>
237<dd>beta is a list of the corresponding SLD values</dd>
238</dl>
239</dd></dl>
240
241<dl class="method">
242<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel.is_fittable">
243<tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.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.ReflectivityIIModel.ReflectivityIIModel.run">
257<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.run" title="Permalink to this definition">¶</a></dt>
258<dd><p>Evaluate the model</p>
259<table class="docutils field-list" frame="void" rules="none">
260<col class="field-name" />
261<col class="field-body" />
262<tbody valign="top">
263<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [q,phi]</td>
264</tr>
265<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
266</tr>
267</tbody>
268</table>
269</dd></dl>
270
271<dl class="method">
272<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel.runXY">
273<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.runXY" title="Permalink to this definition">¶</a></dt>
274<dd><p>Evaluate the model</p>
275<p>: param x: input q-value (float or [float, float] as [qx, qy])
276: return: scattering function value</p>
277</dd></dl>
278
279<dl class="method">
280<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel.setParam">
281<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.setParam" title="Permalink to this definition">¶</a></dt>
282<dd><p>Set the value of a model parameter</p>
283<p>: param name: name of the parameter
284: param value: value of the parameter</p>
285</dd></dl>
286
287<dl class="method">
288<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel.setParamWithToken">
289<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.setParamWithToken" title="Permalink to this definition">¶</a></dt>
290<dd></dd></dl>
291
292<dl class="method">
293<dt id="sans.models.ReflectivityIIModel.ReflectivityIIModel.set_dispersion">
294<tt class="descname">set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflectivityIIModel.ReflectivityIIModel.set_dispersion" title="Permalink to this definition">¶</a></dt>
295<dd><p>Set the dispersion object for a model parameter</p>
296<p>: param parameter: name of the parameter [string]
297:dispersion: dispersion object of type DispersionModel</p>
298</dd></dl>
299
300</dd></dl>
301
302</div>
303</div>
304
305
306          </div>
307        </div>
308      </div>
309      <div class="sphinxsidebar">
310        <div class="sphinxsidebarwrapper">
311  <h3><a href="../index.html">Table Of Contents</a></h3>
312  <ul>
313<li><a class="reference internal" href="#">ReflectivityIIModel</a><ul>
314<li><a class="reference internal" href="#sans-models-reflectivityiimodel"><tt class="docutils literal"><span class="pre">sans.models.ReflectivityIIModel</span></tt></a></li>
315</ul>
316</li>
317</ul>
318
319  <h4>Previous topic</h4>
320  <p class="topless"><a href="ReflAdvModel.html"
321                        title="previous chapter">ReflAdvModel</a></p>
322  <h4>Next topic</h4>
323  <p class="topless"><a href="ReflectivityModel.html"
324                        title="next chapter">ReflectivityModel</a></p>
325  <h3>This Page</h3>
326  <ul class="this-page-menu">
327    <li><a href="../_sources/api/ReflectivityIIModel.txt"
328           rel="nofollow">Show Source</a></li>
329  </ul>
330<div id="searchbox" style="display: none">
331  <h3>Quick search</h3>
332    <form class="search" action="../search.html" method="get">
333      <input type="text" name="q" />
334      <input type="submit" value="Go" />
335      <input type="hidden" name="check_keywords" value="yes" />
336      <input type="hidden" name="area" value="default" />
337    </form>
338    <p class="searchtip" style="font-size: 90%">
339    Enter search terms or a module, class or function name.
340    </p>
341</div>
342<script type="text/javascript">$('#searchbox').show(0);</script>
343        </div>
344      </div>
345      <div class="clearer"></div>
346    </div>
347    <div class="related">
348      <h3>Navigation</h3>
349      <ul>
350        <li class="right" style="margin-right: 10px">
351          <a href="../genindex.html" title="General Index"
352             >index</a></li>
353        <li class="right" >
354          <a href="../py-modindex.html" title="Python Module Index"
355             >modules</a> |</li>
356        <li class="right" >
357          <a href="ReflectivityModel.html" title="ReflectivityModel"
358             >next</a> |</li>
359        <li class="right" >
360          <a href="ReflAdvModel.html" title="ReflAdvModel"
361             >previous</a> |</li>
362        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li>
363          <li><a href="index.html" >Reference</a> &raquo;</li> 
364      </ul>
365    </div>
366    <div class="footer">
367        &copy; Copyright 2010, sans group.
368      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
369    </div>
370  </body>
371</html>
Note: See TracBrowser for help on using the repository browser.