source: sasview/sansmodels/docs/sphinx/html/api/ReflAdvModel.html @ fafdfd3

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

HTML folder generated by Sphinx
  • Property mode set to 100644
File size: 17.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>ReflAdvModel &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="ReflectivityIIModel" href="ReflectivityIIModel.html" />
28    <link rel="prev" title="qsmearing" href="qsmearing.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="ReflectivityIIModel.html" title="ReflectivityIIModel"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="qsmearing.html" title="qsmearing"
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="refladvmodel">
57<h1>ReflAdvModel<a class="headerlink" href="#refladvmodel" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.models.ReflAdvModel">
59<span id="sans-models-refladvmodel"></span><h2><a class="reference internal" href="#module-sans.models.ReflAdvModel" title="sans.models.ReflAdvModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.ReflAdvModel</span></tt></a><a class="headerlink" href="#module-sans.models.ReflAdvModel" 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_adv.h</dt>
72<dd>AND RE-RUN THE GENERATOR SCRIPT</dd>
73</dl>
74<dl class="class">
75<dt id="sans.models.ReflAdvModel.ReflAdvModel">
76<em class="property">class </em><tt class="descclassname">sans.models.ReflAdvModel.</tt><tt class="descname">ReflAdvModel</tt><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel" title="Permalink to this definition">¶</a></dt>
77<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">CReflAdvModel</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 ReflAdvModel model.
80This file was auto-generated from ..c_extensions</div></blockquote>
81<dl class="docutils">
82<dt>efl_adv.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    = 50.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    = 50.0 [A]
105thick_inter2    = 50.0 [A]
106thick_inter3    = 50.0 [A]
107thick_inter4    = 50.0 [A]
108thick_inter5    = 50.0 [A]
109thick_inter6    = 50.0 [A]
110thick_inter7    = 50.0 [A]
111thick_inter8    = 50.0 [A]
112thick_inter9    = 50.0 [A]
113thick_inter10   = 50.0 [A]
114thick_flat1     = 100.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
134sldIM_flat1     = 0.0 [1/A^(2)]
135sldIM_flat2     = 0.0 [1/A^(2)]
136sldIM_flat3     = 0.0 [1/A^(2)]
137sldIM_flat4     = 0.0 [1/A^(2)]
138sldIM_flat5     = 0.0 [1/A^(2)]
139sldIM_flat6     = 0.0 [1/A^(2)]
140sldIM_flat7     = 0.0 [1/A^(2)]
141sldIM_flat8     = 0.0 [1/A^(2)]
142sldIM_flat9     = 0.0 [1/A^(2)]
143sldIM_flat10    = 0.0 [1/A^(2)]
144nu_inter1       = 2.5
145nu_inter2       = 2.5
146nu_inter3       = 2.5
147nu_inter4       = 2.5
148nu_inter5       = 2.5
149nu_inter6       = 2.5
150nu_inter7       = 2.5
151nu_inter8       = 2.5
152nu_inter9       = 2.5
153nu_inter10      = 2.5
154sldIM_sub0      = 0.0
155sldIM_medium    = 0.0
156npts_inter      = 21.0
157nu_inter0       = 2.5</div></blockquote>
158</dd>
159</dl>
160<dl class="method">
161<dt id="sans.models.ReflAdvModel.ReflAdvModel.calculate_ER">
162<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.calculate_ER" title="Permalink to this definition">¶</a></dt>
163<dd><p>Calculate the effective radius for P(q)*S(q)</p>
164<table class="docutils field-list" frame="void" rules="none">
165<col class="field-name" />
166<col class="field-body" />
167<tbody valign="top">
168<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td>
169</tr>
170</tbody>
171</table>
172</dd></dl>
173
174<dl class="method">
175<dt id="sans.models.ReflAdvModel.ReflAdvModel.clone">
176<tt class="descname">clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.clone" title="Permalink to this definition">¶</a></dt>
177<dd><p>Return a identical copy of self</p>
178</dd></dl>
179
180<dl class="attribute">
181<dt id="sans.models.ReflAdvModel.ReflAdvModel.dispersion">
182<tt class="descname">dispersion</tt><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.dispersion" title="Permalink to this definition">¶</a></dt>
183<dd><p>Dispersion parameters</p>
184</dd></dl>
185
186<dl class="method">
187<dt id="sans.models.ReflAdvModel.ReflAdvModel.evalDistribution">
188<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.ReflAdvModel.ReflAdvModel.evalDistribution" title="Permalink to this definition">¶</a></dt>
189<dd><p>Evaluate the model in cartesian coordinates</p>
190<table class="docutils field-list" frame="void" rules="none">
191<col class="field-name" />
192<col class="field-body" />
193<tbody valign="top">
194<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q[], or [qx[], qy[]]</td>
195</tr>
196<tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td>
197</tr>
198</tbody>
199</table>
200</dd></dl>
201
202<dl class="method">
203<dt id="sans.models.ReflAdvModel.ReflAdvModel.getDispParamList">
204<tt class="descname">getDispParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.getDispParamList" title="Permalink to this definition">¶</a></dt>
205<dd><p>Return a list of all available parameters for the model</p>
206</dd></dl>
207
208<dl class="method">
209<dt id="sans.models.ReflAdvModel.ReflAdvModel.getParam">
210<tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.getParam" title="Permalink to this definition">¶</a></dt>
211<dd><p>Set the value of a model parameter</p>
212<table class="docutils field-list" frame="void" rules="none">
213<col class="field-name" />
214<col class="field-body" />
215<tbody valign="top">
216<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td>
217</tr>
218</tbody>
219</table>
220</dd></dl>
221
222<dl class="method">
223<dt id="sans.models.ReflAdvModel.ReflAdvModel.getParamList">
224<tt class="descname">getParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.getParamList" title="Permalink to this definition">¶</a></dt>
225<dd><p>Return a list of all available parameters for the model</p>
226</dd></dl>
227
228<dl class="method">
229<dt id="sans.models.ReflAdvModel.ReflAdvModel.getParamListWithToken">
230<tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt>
231<dd></dd></dl>
232
233<dl class="method">
234<dt id="sans.models.ReflAdvModel.ReflAdvModel.getParamWithToken">
235<tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.getParamWithToken" title="Permalink to this definition">¶</a></dt>
236<dd></dd></dl>
237
238<dl class="method">
239<dt id="sans.models.ReflAdvModel.ReflAdvModel.is_fittable">
240<tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.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"><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="attribute">
253<dt id="sans.models.ReflAdvModel.ReflAdvModel.log">
254<tt class="descname">log</tt><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.log" title="Permalink to this definition">¶</a></dt>
255<dd><p>Log</p>
256</dd></dl>
257
258<dl class="attribute">
259<dt id="sans.models.ReflAdvModel.ReflAdvModel.params">
260<tt class="descname">params</tt><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.params" title="Permalink to this definition">¶</a></dt>
261<dd><p>Parameters</p>
262</dd></dl>
263
264<dl class="attribute">
265<dt id="sans.models.ReflAdvModel.ReflAdvModel.reset">
266<tt class="descname">reset</tt><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.reset" title="Permalink to this definition">¶</a></dt>
267<dd><p>Reset pair correlation</p>
268</dd></dl>
269
270<dl class="method">
271<dt id="sans.models.ReflAdvModel.ReflAdvModel.run">
272<tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.run" title="Permalink to this definition">¶</a></dt>
273<dd><p>Evaluate the model</p>
274<table class="docutils field-list" frame="void" rules="none">
275<col class="field-name" />
276<col class="field-body" />
277<tbody valign="top">
278<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [q,phi]</td>
279</tr>
280<tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
281</tr>
282</tbody>
283</table>
284</dd></dl>
285
286<dl class="method">
287<dt id="sans.models.ReflAdvModel.ReflAdvModel.runXY">
288<tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.runXY" title="Permalink to this definition">¶</a></dt>
289<dd><p>Evaluate the model in cartesian coordinates</p>
290<table class="docutils field-list" frame="void" rules="none">
291<col class="field-name" />
292<col class="field-body" />
293<tbody valign="top">
294<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [qx, qy]</td>
295</tr>
296<tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
297</tr>
298</tbody>
299</table>
300</dd></dl>
301
302<dl class="method">
303<dt id="sans.models.ReflAdvModel.ReflAdvModel.setParam">
304<tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.setParam" title="Permalink to this definition">¶</a></dt>
305<dd><p>Set the value of a model parameter</p>
306<table class="docutils field-list" frame="void" rules="none">
307<col class="field-name" />
308<col class="field-body" />
309<tbody valign="top">
310<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
311<li><strong>name</strong> &#8211; name of the parameter</li>
312<li><strong>value</strong> &#8211; value of the parameter</li>
313</ul>
314</td>
315</tr>
316</tbody>
317</table>
318</dd></dl>
319
320<dl class="method">
321<dt id="sans.models.ReflAdvModel.ReflAdvModel.setParamWithToken">
322<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.ReflAdvModel.ReflAdvModel.setParamWithToken" title="Permalink to this definition">¶</a></dt>
323<dd></dd></dl>
324
325<dl class="method">
326<dt id="sans.models.ReflAdvModel.ReflAdvModel.set_dispersion">
327<tt class="descname">set_dispersion</tt><big>(</big><em>parameter</em>, <em>dispersion</em><big>)</big><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.set_dispersion" title="Permalink to this definition">¶</a></dt>
328<dd><p>Set the dispersion object for a model parameter</p>
329<table class="docutils field-list" frame="void" rules="none">
330<col class="field-name" />
331<col class="field-body" />
332<tbody valign="top">
333<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
334<li><strong>parameter</strong> &#8211; name of the parameter [string]</li>
335<li><strong>dispersion</strong> &#8211; dispersion object of type DispersionModel</li>
336</ul>
337</td>
338</tr>
339</tbody>
340</table>
341</dd></dl>
342
343</dd></dl>
344
345<dl class="function">
346<dt id="sans.models.ReflAdvModel.create_ReflAdvModel">
347<tt class="descclassname">sans.models.ReflAdvModel.</tt><tt class="descname">create_ReflAdvModel</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflAdvModel.create_ReflAdvModel" title="Permalink to this definition">¶</a></dt>
348<dd></dd></dl>
349
350</div>
351</div>
352
353
354          </div>
355        </div>
356      </div>
357      <div class="sphinxsidebar">
358        <div class="sphinxsidebarwrapper">
359  <h3><a href="../index.html">Table Of Contents</a></h3>
360  <ul>
361<li><a class="reference internal" href="#">ReflAdvModel</a><ul>
362<li><a class="reference internal" href="#module-sans.models.ReflAdvModel"><tt class="docutils literal"><span class="pre">sans.models.ReflAdvModel</span></tt></a></li>
363</ul>
364</li>
365</ul>
366
367  <h4>Previous topic</h4>
368  <p class="topless"><a href="qsmearing.html"
369                        title="previous chapter">qsmearing</a></p>
370  <h4>Next topic</h4>
371  <p class="topless"><a href="ReflectivityIIModel.html"
372                        title="next chapter">ReflectivityIIModel</a></p>
373  <h3>This Page</h3>
374  <ul class="this-page-menu">
375    <li><a href="../_sources/api/ReflAdvModel.txt"
376           rel="nofollow">Show Source</a></li>
377  </ul>
378<div id="searchbox" style="display: none">
379  <h3>Quick search</h3>
380    <form class="search" action="../search.html" method="get">
381      <input type="text" name="q" size="18" />
382      <input type="submit" value="Go" />
383      <input type="hidden" name="check_keywords" value="yes" />
384      <input type="hidden" name="area" value="default" />
385    </form>
386    <p class="searchtip" style="font-size: 90%">
387    Enter search terms or a module, class or function name.
388    </p>
389</div>
390<script type="text/javascript">$('#searchbox').show(0);</script>
391        </div>
392      </div>
393      <div class="clearer"></div>
394    </div>
395    <div class="related">
396      <h3>Navigation</h3>
397      <ul>
398        <li class="right" style="margin-right: 10px">
399          <a href="../genindex.html" title="General Index"
400             >index</a></li>
401        <li class="right" >
402          <a href="../py-modindex.html" title="Python Module Index"
403             >modules</a> |</li>
404        <li class="right" >
405          <a href="ReflectivityIIModel.html" title="ReflectivityIIModel"
406             >next</a> |</li>
407        <li class="right" >
408          <a href="qsmearing.html" title="qsmearing"
409             >previous</a> |</li>
410        <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li>
411          <li><a href="index.html" >Reference</a> &raquo;</li> 
412      </ul>
413    </div>
414    <div class="footer">
415        &copy; Copyright 2010, sans group.
416      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
417    </div>
418  </body>
419</html>
Note: See TracBrowser for help on using the repository browser.