source: sasview/sansmodels/docs/sphinx/html/api/ReflModel.html @ 5f696f8

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

HTML folder generated by Sphinx
  • Property mode set to 100644
File size: 16.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>ReflModel &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="RPA10Model" href="RPA10Model.html" />
28    <link rel="prev" title="ReflectivityModel" href="ReflectivityModel.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="RPA10Model.html" title="RPA10Model"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="ReflectivityModel.html" title="ReflectivityModel"
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="reflmodel">
57<h1>ReflModel<a class="headerlink" href="#reflmodel" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.models.ReflModel">
59<span id="sans-models-reflmodel"></span><h2><a class="reference internal" href="#module-sans.models.ReflModel" title="sans.models.ReflModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.ReflModel</span></tt></a><a class="headerlink" href="#module-sans.models.ReflModel" title="Permalink to this headline">¶</a></h2>
60<p>Provide functionality for a C extension model</p>
61<table class="docutils field-list" frame="void" rules="none">
62<col class="field-name" />
63<col class="field-body" />
64<tbody valign="top">
65<tr class="field"><th class="field-name">WARNING:</th><td class="field-body">THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY
66DO NOT MODIFY THIS FILE, MODIFY ..c_extensions</td>
67</tr>
68</tbody>
69</table>
70<dl class="docutils">
71<dt>efl.h</dt>
72<dd>AND RE-RUN THE GENERATOR SCRIPT</dd>
73</dl>
74<dl class="class">
75<dt id="sans.models.ReflModel.ReflModel">
76<em class="property">class </em><tt class="descclassname">sans.models.ReflModel.</tt><tt class="descname">ReflModel</tt><a class="headerlink" href="#sans.models.ReflModel.ReflModel" title="Permalink to this definition">¶</a></dt>
77<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">CReflModel</span></tt>, <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>
78<blockquote>
79<div>Class that evaluates a ReflModel model.
80This file was auto-generated from ..c_extensions</div></blockquote>
81<dl class="docutils">
82<dt>efl.h.</dt>
83<dd><p class="first">Refer to that file and the structure it contains
84for details of the model.
85List of default parameters:</p>
86<blockquote class="last">
87<div>n_layers        = 1.0
88scale           = 1.0
89thick_inter0    = 1.0 [A]
90func_inter0     = 0.0
91sld_bottom0     = 2.07e-06 [1/A^(2)]
92sld_medium      = 1e-06 [1/A^(2)]
93background      = 0.0
94sld_flat1       = 4e-06 [1/A^(2)]
95sld_flat2       = 3.5e-06 [1/A^(2)]
96sld_flat3       = 4e-06 [1/A^(2)]
97sld_flat4       = 3.5e-06 [1/A^(2)]
98sld_flat5       = 4e-06 [1/A^(2)]
99sld_flat6       = 3.5e-06 [1/A^(2)]
100sld_flat7       = 4e-06 [1/A^(2)]
101sld_flat8       = 3.5e-06 [1/A^(2)]
102sld_flat9       = 4e-06 [1/A^(2)]
103sld_flat10      = 3.5e-06 [1/A^(2)]
104thick_inter1    = 1.0 [A]
105thick_inter2    = 1.0 [A]
106thick_inter3    = 1.0 [A]
107thick_inter4    = 1.0 [A]
108thick_inter5    = 1.0 [A]
109thick_inter6    = 1.0 [A]
110thick_inter7    = 1.0 [A]
111thick_inter8    = 1.0 [A]
112thick_inter9    = 1.0 [A]
113thick_inter10   = 1.0 [A]
114thick_flat1     = 10.0 [A]
115thick_flat2     = 100.0 [A]
116thick_flat3     = 100.0 [A]
117thick_flat4     = 100.0 [A]
118thick_flat5     = 100.0 [A]
119thick_flat6     = 100.0 [A]
120thick_flat7     = 100.0 [A]
121thick_flat8     = 100.0 [A]
122thick_flat9     = 100.0 [A]
123thick_flat10    = 100.0 [A]
124func_inter1     = 0.0
125func_inter2     = 0.0
126func_inter3     = 0.0
127func_inter4     = 0.0
128func_inter5     = 0.0
129func_inter6     = 0.0
130func_inter7     = 0.0
131func_inter8     = 0.0
132func_inter9     = 0.0
133func_inter10    = 0.0</div></blockquote>
134</dd>
135</dl>
136<dl class="method">
137<dt id="sans.models.ReflModel.ReflModel.calculate_ER">
138<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflModel.ReflModel.calculate_ER" title="Permalink to this definition">¶</a></dt>
139<dd><p>Calculate the effective radius for P(q)*S(q)</p>
140<table class="docutils field-list" frame="void" rules="none">
141<col class="field-name" />
142<col class="field-body" />
143<tbody valign="top">
144<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td>
145</tr>
146</tbody>
147</table>
148</dd></dl>
149
150<dl class="method">
151<dt id="sans.models.ReflModel.ReflModel.clone">
152<tt class="descname">clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflModel.ReflModel.clone" title="Permalink to this definition">¶</a></dt>
153<dd><p>Return a identical copy of self</p>
154</dd></dl>
155
156<dl class="attribute">
157<dt id="sans.models.ReflModel.ReflModel.dispersion">
158<tt class="descname">dispersion</tt><a class="headerlink" href="#sans.models.ReflModel.ReflModel.dispersion" title="Permalink to this definition">¶</a></dt>
159<dd><p>Dispersion parameters</p>
160</dd></dl>
161
162<dl class="method">
163<dt id="sans.models.ReflModel.ReflModel.evalDistribution">
164<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.ReflModel.ReflModel.evalDistribution" title="Permalink to this definition">¶</a></dt>
165<dd><p>Evaluate the model in cartesian coordinates</p>
166<table class="docutils field-list" frame="void" rules="none">
167<col class="field-name" />
168<col class="field-body" />
169<tbody valign="top">
170<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q[], or [qx[], qy[]]</td>
171</tr>
172<tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td>
173</tr>
174</tbody>
175</table>
176</dd></dl>
177
178<dl class="method">
179<dt id="sans.models.ReflModel.ReflModel.getDispParamList">
180<tt class="descname">getDispParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflModel.ReflModel.getDispParamList" title="Permalink to this definition">¶</a></dt>
181<dd><p>Return a list of all available parameters for the model</p>
182</dd></dl>
183
184<dl class="method">
185<dt id="sans.models.ReflModel.ReflModel.getParam">
186<tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.ReflModel.ReflModel.getParam" title="Permalink to this definition">¶</a></dt>
187<dd><p>Set the value of a model parameter</p>
188<table class="docutils field-list" frame="void" rules="none">
189<col class="field-name" />
190<col class="field-body" />
191<tbody valign="top">
192<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td>
193</tr>
194</tbody>
195</table>
196</dd></dl>
197
198<dl class="method">
199<dt id="sans.models.ReflModel.ReflModel.getParamList">
200<tt class="descname">getParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflModel.ReflModel.getParamList" title="Permalink to this definition">¶</a></dt>
201<dd><p>Return a list of all available parameters for the model</p>
202</dd></dl>
203
204<dl class="method">
205<dt id="sans.models.ReflModel.ReflModel.getParamListWithToken">
206<tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.ReflModel.ReflModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt>
207<dd></dd></dl>
208
209<dl class="method">
210<dt id="sans.models.ReflModel.ReflModel.getParamWithToken">
211<tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.ReflModel.ReflModel.getParamWithToken" title="Permalink to this definition">¶</a></dt>
212<dd></dd></dl>
213
214<dl class="method">
215<dt id="sans.models.ReflModel.ReflModel.is_fittable">
216<tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.ReflModel.ReflModel.is_fittable" title="Permalink to this definition">¶</a></dt>
217<dd><p>Check if a given parameter is fittable or not</p>
218<table class="docutils field-list" frame="void" rules="none">
219<col class="field-name" />
220<col class="field-body" />
221<tbody valign="top">
222<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td>
223</tr>
224</tbody>
225</table>
226</dd></dl>
227
228<dl class="attribute">
229<dt id="sans.models.ReflModel.ReflModel.log">
230<tt class="descname">log</tt><a class="headerlink" href="#sans.models.ReflModel.ReflModel.log" title="Permalink to this definition">¶</a></dt>
231<dd><p>Log</p>
232</dd></dl>
233
234<dl class="attribute">
235<dt id="sans.models.ReflModel.ReflModel.params">
236<tt class="descname">params</tt><a class="headerlink" href="#sans.models.ReflModel.ReflModel.params" title="Permalink to this definition">¶</a></dt>
237<dd><p>Parameters</p>
238</dd></dl>
239
240<dl class="attribute">
241<dt id="sans.models.ReflModel.ReflModel.reset">
242<tt class="descname">reset</tt><a class="headerlink" href="#sans.models.ReflModel.ReflModel.reset" title="Permalink to this definition">¶</a></dt>
243<dd><p>Reset pair correlation</p>
244</dd></dl>
245
246<dl class="method">
247<dt id="sans.models.ReflModel.ReflModel.run">
248<tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.ReflModel.ReflModel.run" title="Permalink to this definition">¶</a></dt>
249<dd><p>Evaluate the model</p>
250<table class="docutils field-list" frame="void" rules="none">
251<col class="field-name" />
252<col class="field-body" />
253<tbody valign="top">
254<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [q,phi]</td>
255</tr>
256<tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
257</tr>
258</tbody>
259</table>
260</dd></dl>
261
262<dl class="method">
263<dt id="sans.models.ReflModel.ReflModel.runXY">
264<tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.ReflModel.ReflModel.runXY" title="Permalink to this definition">¶</a></dt>
265<dd><p>Evaluate the model in cartesian coordinates</p>
266<table class="docutils field-list" frame="void" rules="none">
267<col class="field-name" />
268<col class="field-body" />
269<tbody valign="top">
270<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [qx, qy]</td>
271</tr>
272<tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
273</tr>
274</tbody>
275</table>
276</dd></dl>
277
278<dl class="method">
279<dt id="sans.models.ReflModel.ReflModel.setParam">
280<tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.ReflModel.ReflModel.setParam" title="Permalink to this definition">¶</a></dt>
281<dd><p>Set the value of a model parameter</p>
282<table class="docutils field-list" frame="void" rules="none">
283<col class="field-name" />
284<col class="field-body" />
285<tbody valign="top">
286<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
287<li><strong>name</strong> &#8211; name of the parameter</li>
288<li><strong>value</strong> &#8211; value of the parameter</li>
289</ul>
290</td>
291</tr>
292</tbody>
293</table>
294</dd></dl>
295
296<dl class="method">
297<dt id="sans.models.ReflModel.ReflModel.setParamWithToken">
298<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.ReflModel.ReflModel.setParamWithToken" title="Permalink to this definition">¶</a></dt>
299<dd></dd></dl>
300
301<dl class="method">
302<dt id="sans.models.ReflModel.ReflModel.set_dispersion">
303<tt class="descname">set_dispersion</tt><big>(</big><em>parameter</em>, <em>dispersion</em><big>)</big><a class="headerlink" href="#sans.models.ReflModel.ReflModel.set_dispersion" title="Permalink to this definition">¶</a></dt>
304<dd><p>Set the dispersion object for a model parameter</p>
305<table class="docutils field-list" frame="void" rules="none">
306<col class="field-name" />
307<col class="field-body" />
308<tbody valign="top">
309<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
310<li><strong>parameter</strong> &#8211; name of the parameter [string]</li>
311<li><strong>dispersion</strong> &#8211; dispersion object of type DispersionModel</li>
312</ul>
313</td>
314</tr>
315</tbody>
316</table>
317</dd></dl>
318
319</dd></dl>
320
321<dl class="function">
322<dt id="sans.models.ReflModel.create_ReflModel">
323<tt class="descclassname">sans.models.ReflModel.</tt><tt class="descname">create_ReflModel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflModel.create_ReflModel" title="Permalink to this definition">¶</a></dt>
324<dd></dd></dl>
325
326</div>
327</div>
328
329
330          </div>
331        </div>
332      </div>
333      <div class="sphinxsidebar">
334        <div class="sphinxsidebarwrapper">
335  <h3><a href="../index.html">Table Of Contents</a></h3>
336  <ul>
337<li><a class="reference internal" href="#">ReflModel</a><ul>
338<li><a class="reference internal" href="#module-sans.models.ReflModel"><tt class="docutils literal"><span class="pre">sans.models.ReflModel</span></tt></a></li>
339</ul>
340</li>
341</ul>
342
343  <h4>Previous topic</h4>
344  <p class="topless"><a href="ReflectivityModel.html"
345                        title="previous chapter">ReflectivityModel</a></p>
346  <h4>Next topic</h4>
347  <p class="topless"><a href="RPA10Model.html"
348                        title="next chapter">RPA10Model</a></p>
349  <h3>This Page</h3>
350  <ul class="this-page-menu">
351    <li><a href="../_sources/api/ReflModel.txt"
352           rel="nofollow">Show Source</a></li>
353  </ul>
354<div id="searchbox" style="display: none">
355  <h3>Quick search</h3>
356    <form class="search" action="../search.html" method="get">
357      <input type="text" name="q" size="18" />
358      <input type="submit" value="Go" />
359      <input type="hidden" name="check_keywords" value="yes" />
360      <input type="hidden" name="area" value="default" />
361    </form>
362    <p class="searchtip" style="font-size: 90%">
363    Enter search terms or a module, class or function name.
364    </p>
365</div>
366<script type="text/javascript">$('#searchbox').show(0);</script>
367        </div>
368      </div>
369      <div class="clearer"></div>
370    </div>
371    <div class="related">
372      <h3>Navigation</h3>
373      <ul>
374        <li class="right" style="margin-right: 10px">
375          <a href="../genindex.html" title="General Index"
376             >index</a></li>
377        <li class="right" >
378          <a href="../py-modindex.html" title="Python Module Index"
379             >modules</a> |</li>
380        <li class="right" >
381          <a href="RPA10Model.html" title="RPA10Model"
382             >next</a> |</li>
383        <li class="right" >
384          <a href="ReflectivityModel.html" title="ReflectivityModel"
385             >previous</a> |</li>
386        <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li>
387          <li><a href="index.html" >Reference</a> &raquo;</li> 
388      </ul>
389    </div>
390    <div class="footer">
391        &copy; Copyright 2010, sans group.
392      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
393    </div>
394  </body>
395</html>
Note: See TracBrowser for help on using the repository browser.