source: sasview/sansmodels/docs/sphinx/html/api/ReflectivityModel.html @ dbdff5e

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

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