source: sasview/sansmodels/docs/sphinx/html/api/ReflAdvModel.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: 23.7 KB
RevLine 
[512573a]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
[c0d873f]6
[512573a]7<html xmlns="http://www.w3.org/1999/xhtml">
8  <head>
9    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10   
[c0d873f]11    <title>ReflAdvModel &mdash; sansmodels 0.1.0 documentation</title>
12   
[512573a]13    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
14    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
[c0d873f]15   
[512573a]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>
[c0d873f]28    <link rel="top" title="sansmodels 0.1.0 documentation" href="../index.html" />
[512573a]29    <link rel="up" title="Reference" href="index.html" />
30    <link rel="next" title="ReflectivityIIModel" href="ReflectivityIIModel.html" />
31    <link rel="prev" title="qsmearing" href="qsmearing.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="ReflectivityIIModel.html" title="ReflectivityIIModel"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="qsmearing.html" title="qsmearing"
48             accesskey="P">previous</a> |</li>
[c0d873f]49        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li>
[512573a]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="refladvmodel">
60<h1>ReflAdvModel<a class="headerlink" href="#refladvmodel" title="Permalink to this headline">¶</a></h1>
[c0d873f]61<div class="section" id="sans-models-refladvmodel">
62<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="#sans-models-refladvmodel" title="Permalink to this headline">¶</a></h2>
63<span class="target" id="module-sans.models.ReflAdvModel"></span><p>Provide functionality for a C extension model</p>
[512573a]64<table class="docutils field-list" frame="void" rules="none">
65<col class="field-name" />
66<col class="field-body" />
67<tbody valign="top">
[c0d873f]68<tr class="field-odd field"><th class="field-name">WARNING:</th><td class="field-body">THIS FILE WAS GENERATED BY WRAPPERGENERATOR.PY
[512573a]69DO NOT MODIFY THIS FILE, MODIFY ..c_extensions</td>
70</tr>
71</tbody>
72</table>
73<dl class="docutils">
74<dt>efl_adv.h</dt>
75<dd>AND RE-RUN THE GENERATOR SCRIPT</dd>
76</dl>
77<dl class="class">
78<dt id="sans.models.ReflAdvModel.ReflAdvModel">
79<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>
80<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>
81<blockquote>
82<div>Class that evaluates a ReflAdvModel model.
83This file was auto-generated from ..c_extensions</div></blockquote>
84<dl class="docutils">
85<dt>efl_adv.h.</dt>
86<dd><p class="first">Refer to that file and the structure it contains
87for details of the model.
88List of default parameters:</p>
89<blockquote class="last">
90<div>n_layers        = 1.0
91scale           = 1.0
92thick_inter0    = 50.0 [A]
93func_inter0     = 0.0
94sld_bottom0     = 2.07e-06 [1/A^(2)]
95sld_medium      = 1e-06 [1/A^(2)]
96background      = 0.0
97sld_flat1       = 4e-06 [1/A^(2)]
98sld_flat2       = 3.5e-06 [1/A^(2)]
99sld_flat3       = 4e-06 [1/A^(2)]
100sld_flat4       = 3.5e-06 [1/A^(2)]
101sld_flat5       = 4e-06 [1/A^(2)]
102sld_flat6       = 3.5e-06 [1/A^(2)]
103sld_flat7       = 4e-06 [1/A^(2)]
104sld_flat8       = 3.5e-06 [1/A^(2)]
105sld_flat9       = 4e-06 [1/A^(2)]
106sld_flat10      = 3.5e-06 [1/A^(2)]
107thick_inter1    = 50.0 [A]
108thick_inter2    = 50.0 [A]
109thick_inter3    = 50.0 [A]
110thick_inter4    = 50.0 [A]
111thick_inter5    = 50.0 [A]
112thick_inter6    = 50.0 [A]
113thick_inter7    = 50.0 [A]
114thick_inter8    = 50.0 [A]
115thick_inter9    = 50.0 [A]
116thick_inter10   = 50.0 [A]
117thick_flat1     = 100.0 [A]
118thick_flat2     = 100.0 [A]
119thick_flat3     = 100.0 [A]
120thick_flat4     = 100.0 [A]
121thick_flat5     = 100.0 [A]
122thick_flat6     = 100.0 [A]
123thick_flat7     = 100.0 [A]
124thick_flat8     = 100.0 [A]
125thick_flat9     = 100.0 [A]
126thick_flat10    = 100.0 [A]
127func_inter1     = 0.0
128func_inter2     = 0.0
129func_inter3     = 0.0
130func_inter4     = 0.0
131func_inter5     = 0.0
132func_inter6     = 0.0
133func_inter7     = 0.0
134func_inter8     = 0.0
135func_inter9     = 0.0
136func_inter10    = 0.0
137sldIM_flat1     = 0.0 [1/A^(2)]
138sldIM_flat2     = 0.0 [1/A^(2)]
139sldIM_flat3     = 0.0 [1/A^(2)]
140sldIM_flat4     = 0.0 [1/A^(2)]
141sldIM_flat5     = 0.0 [1/A^(2)]
142sldIM_flat6     = 0.0 [1/A^(2)]
143sldIM_flat7     = 0.0 [1/A^(2)]
144sldIM_flat8     = 0.0 [1/A^(2)]
145sldIM_flat9     = 0.0 [1/A^(2)]
146sldIM_flat10    = 0.0 [1/A^(2)]
147nu_inter1       = 2.5
148nu_inter2       = 2.5
149nu_inter3       = 2.5
150nu_inter4       = 2.5
151nu_inter5       = 2.5
152nu_inter6       = 2.5
153nu_inter7       = 2.5
154nu_inter8       = 2.5
155nu_inter9       = 2.5
156nu_inter10      = 2.5
157sldIM_sub0      = 0.0
158sldIM_medium    = 0.0
159npts_inter      = 21.0
160nu_inter0       = 2.5</div></blockquote>
161</dd>
162</dl>
163<dl class="method">
[c0d873f]164<dt id="sans.models.ReflAdvModel.ReflAdvModel.__add__">
165<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.__add__" title="Permalink to this definition">¶</a></dt>
166<dd></dd></dl>
167
168<dl class="attribute">
169<dt id="sans.models.ReflAdvModel.ReflAdvModel.__class__">
170<tt class="descname">__class__</tt><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.__class__" title="Permalink to this definition">¶</a></dt>
171<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p>
172</dd></dl>
173
174<dl class="attribute">
175<dt id="sans.models.ReflAdvModel.ReflAdvModel.__delattr__">
176<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.__delattr__" title="Permalink to this definition">¶</a></dt>
177<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p>
178</dd></dl>
179
180<dl class="attribute">
181<dt id="sans.models.ReflAdvModel.ReflAdvModel.__dict__">
182<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x02ED0DF0&gt;</em><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.__dict__" title="Permalink to this definition">¶</a></dt>
183<dd></dd></dl>
184
185<dl class="method">
186<dt id="sans.models.ReflAdvModel.ReflAdvModel.__div__">
187<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.__div__" title="Permalink to this definition">¶</a></dt>
188<dd></dd></dl>
189
190<dl class="attribute">
191<dt id="sans.models.ReflAdvModel.ReflAdvModel.__getattribute__">
192<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.__getattribute__" title="Permalink to this definition">¶</a></dt>
193<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p>
194</dd></dl>
195
196<dl class="attribute">
197<dt id="sans.models.ReflAdvModel.ReflAdvModel.__hash__">
198<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.__hash__" title="Permalink to this definition">¶</a></dt>
199<dd><p>x.__hash__() &lt;==&gt; hash(x)</p>
200</dd></dl>
201
202<dl class="method">
203<dt id="sans.models.ReflAdvModel.ReflAdvModel.__init__">
204<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.__init__" title="Permalink to this definition">¶</a></dt>
205<dd><p>Initialization</p>
206</dd></dl>
207
208<dl class="attribute">
209<dt id="sans.models.ReflAdvModel.ReflAdvModel.__module__">
210<tt class="descname">__module__</tt><em class="property"> = 'sans.models.ReflAdvModel'</em><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.__module__" title="Permalink to this definition">¶</a></dt>
211<dd></dd></dl>
212
213<dl class="method">
214<dt id="sans.models.ReflAdvModel.ReflAdvModel.__mul__">
215<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.__mul__" title="Permalink to this definition">¶</a></dt>
216<dd></dd></dl>
217
218<dl class="staticmethod">
219<dt id="sans.models.ReflAdvModel.ReflAdvModel.__new__">
220<em class="property">static </em><tt class="descname">__new__</tt><big>(</big><em>S</em>, <em>...</em><big>)</big> &rarr; a new object with type S, a subtype of T<a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.__new__" title="Permalink to this definition">¶</a></dt>
221<dd></dd></dl>
222
223<dl class="method">
224<dt id="sans.models.ReflAdvModel.ReflAdvModel.__reduce__">
225<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.__reduce__" title="Permalink to this definition">¶</a></dt>
226<dd><p>helper for pickle</p>
227</dd></dl>
228
229<dl class="method">
230<dt id="sans.models.ReflAdvModel.ReflAdvModel.__reduce_ex__">
231<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.__reduce_ex__" title="Permalink to this definition">¶</a></dt>
232<dd><p>Overwrite the __reduce_ex__ of PyTypeObject <a href="#id1"><span class="problematic" id="id2">*</span></a>type call in the init of
233c model.</p>
234</dd></dl>
235
236<dl class="attribute">
237<dt id="sans.models.ReflAdvModel.ReflAdvModel.__repr__">
238<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.__repr__" title="Permalink to this definition">¶</a></dt>
239<dd><p>x.__repr__() &lt;==&gt; repr(x)</p>
240</dd></dl>
241
242<dl class="attribute">
243<dt id="sans.models.ReflAdvModel.ReflAdvModel.__setattr__">
244<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.__setattr__" title="Permalink to this definition">¶</a></dt>
245<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p>
246</dd></dl>
247
248<dl class="method">
249<dt id="sans.models.ReflAdvModel.ReflAdvModel.__setstate__">
250<tt class="descname">__setstate__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.__setstate__" title="Permalink to this definition">¶</a></dt>
251<dd><p>restore the state of a model from pickle</p>
252</dd></dl>
253
254<dl class="attribute">
255<dt id="sans.models.ReflAdvModel.ReflAdvModel.__str__">
256<tt class="descname">__str__</tt><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.__str__" title="Permalink to this definition">¶</a></dt>
257<dd><p>x.__str__() &lt;==&gt; str(x)</p>
258</dd></dl>
259
260<dl class="method">
261<dt id="sans.models.ReflAdvModel.ReflAdvModel.__sub__">
262<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.__sub__" title="Permalink to this definition">¶</a></dt>
263<dd></dd></dl>
264
265<dl class="attribute">
266<dt id="sans.models.ReflAdvModel.ReflAdvModel.__weakref__">
267<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.__weakref__" title="Permalink to this definition">¶</a></dt>
268<dd><p>list of weak references to the object (if defined)</p>
269</dd></dl>
270
271<dl class="method">
272<dt id="sans.models.ReflAdvModel.ReflAdvModel._clone">
273<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>
274<dd><p>Internal utility function to copy the internal
275data members to a fresh copy.</p>
276</dd></dl>
277
278<dl class="method">
[512573a]279<dt id="sans.models.ReflAdvModel.ReflAdvModel.calculate_ER">
280<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>
281<dd><p>Calculate the effective radius for P(q)*S(q)</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">
[c0d873f]286<tr class="field-odd field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td>
[512573a]287</tr>
288</tbody>
289</table>
290</dd></dl>
291
292<dl class="method">
293<dt id="sans.models.ReflAdvModel.ReflAdvModel.clone">
294<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>
295<dd><p>Return a identical copy of self</p>
296</dd></dl>
297
298<dl class="attribute">
299<dt id="sans.models.ReflAdvModel.ReflAdvModel.dispersion">
300<tt class="descname">dispersion</tt><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.dispersion" title="Permalink to this definition">¶</a></dt>
301<dd><p>Dispersion parameters</p>
302</dd></dl>
303
304<dl class="method">
305<dt id="sans.models.ReflAdvModel.ReflAdvModel.evalDistribution">
[c0d873f]306<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.evalDistribution" title="Permalink to this definition">¶</a></dt>
[512573a]307<dd><p>Evaluate the model in cartesian coordinates</p>
308<table class="docutils field-list" frame="void" rules="none">
309<col class="field-name" />
310<col class="field-body" />
311<tbody valign="top">
[c0d873f]312<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q[], or [qx[], qy[]]</td>
[512573a]313</tr>
[c0d873f]314<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td>
[512573a]315</tr>
316</tbody>
317</table>
318</dd></dl>
319
320<dl class="method">
321<dt id="sans.models.ReflAdvModel.ReflAdvModel.getDispParamList">
322<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>
323<dd><p>Return a list of all available parameters for the model</p>
324</dd></dl>
325
326<dl class="method">
327<dt id="sans.models.ReflAdvModel.ReflAdvModel.getParam">
[c0d873f]328<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.getParam" title="Permalink to this definition">¶</a></dt>
[512573a]329<dd><p>Set the value of a model parameter</p>
330<table class="docutils field-list" frame="void" rules="none">
331<col class="field-name" />
332<col class="field-body" />
333<tbody valign="top">
[c0d873f]334<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td>
[512573a]335</tr>
336</tbody>
337</table>
338</dd></dl>
339
340<dl class="method">
341<dt id="sans.models.ReflAdvModel.ReflAdvModel.getParamList">
342<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>
343<dd><p>Return a list of all available parameters for the model</p>
344</dd></dl>
345
346<dl class="method">
347<dt id="sans.models.ReflAdvModel.ReflAdvModel.getParamListWithToken">
[c0d873f]348<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt>
[512573a]349<dd></dd></dl>
350
351<dl class="method">
352<dt id="sans.models.ReflAdvModel.ReflAdvModel.getParamWithToken">
[c0d873f]353<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.getParamWithToken" title="Permalink to this definition">¶</a></dt>
[512573a]354<dd></dd></dl>
355
356<dl class="method">
357<dt id="sans.models.ReflAdvModel.ReflAdvModel.is_fittable">
[c0d873f]358<tt class="descname">is_fittable</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.is_fittable" title="Permalink to this definition">¶</a></dt>
[512573a]359<dd><p>Check if a given parameter is fittable or not</p>
360<table class="docutils field-list" frame="void" rules="none">
361<col class="field-name" />
362<col class="field-body" />
363<tbody valign="top">
[c0d873f]364<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>
[512573a]365</tr>
366</tbody>
367</table>
368</dd></dl>
369
370<dl class="attribute">
371<dt id="sans.models.ReflAdvModel.ReflAdvModel.log">
372<tt class="descname">log</tt><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.log" title="Permalink to this definition">¶</a></dt>
373<dd><p>Log</p>
374</dd></dl>
375
376<dl class="attribute">
377<dt id="sans.models.ReflAdvModel.ReflAdvModel.params">
378<tt class="descname">params</tt><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.params" title="Permalink to this definition">¶</a></dt>
379<dd><p>Parameters</p>
380</dd></dl>
381
[c0d873f]382<dl class="method">
[512573a]383<dt id="sans.models.ReflAdvModel.ReflAdvModel.reset">
[c0d873f]384<tt class="descname">reset</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.reset" title="Permalink to this definition">¶</a></dt>
[512573a]385<dd><p>Reset pair correlation</p>
386</dd></dl>
387
388<dl class="method">
389<dt id="sans.models.ReflAdvModel.ReflAdvModel.run">
[c0d873f]390<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.run" title="Permalink to this definition">¶</a></dt>
[512573a]391<dd><p>Evaluate the model</p>
392<table class="docutils field-list" frame="void" rules="none">
393<col class="field-name" />
394<col class="field-body" />
395<tbody valign="top">
[c0d873f]396<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>
[512573a]397</tr>
[c0d873f]398<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
[512573a]399</tr>
400</tbody>
401</table>
402</dd></dl>
403
404<dl class="method">
405<dt id="sans.models.ReflAdvModel.ReflAdvModel.runXY">
[c0d873f]406<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.runXY" title="Permalink to this definition">¶</a></dt>
[512573a]407<dd><p>Evaluate the model in cartesian coordinates</p>
408<table class="docutils field-list" frame="void" rules="none">
409<col class="field-name" />
410<col class="field-body" />
411<tbody valign="top">
[c0d873f]412<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [qx, qy]</td>
[512573a]413</tr>
[c0d873f]414<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
[512573a]415</tr>
416</tbody>
417</table>
418</dd></dl>
419
420<dl class="method">
421<dt id="sans.models.ReflAdvModel.ReflAdvModel.setParam">
[c0d873f]422<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.setParam" title="Permalink to this definition">¶</a></dt>
[512573a]423<dd><p>Set the value of a model parameter</p>
424<table class="docutils field-list" frame="void" rules="none">
425<col class="field-name" />
426<col class="field-body" />
427<tbody valign="top">
[c0d873f]428<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
[512573a]429<li><strong>name</strong> &#8211; name of the parameter</li>
430<li><strong>value</strong> &#8211; value of the parameter</li>
431</ul>
432</td>
433</tr>
434</tbody>
435</table>
436</dd></dl>
437
438<dl class="method">
439<dt id="sans.models.ReflAdvModel.ReflAdvModel.setParamWithToken">
[c0d873f]440<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.setParamWithToken" title="Permalink to this definition">¶</a></dt>
[512573a]441<dd></dd></dl>
442
443<dl class="method">
444<dt id="sans.models.ReflAdvModel.ReflAdvModel.set_dispersion">
[c0d873f]445<tt class="descname">set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.ReflAdvModel.ReflAdvModel.set_dispersion" title="Permalink to this definition">¶</a></dt>
[512573a]446<dd><p>Set the dispersion object for a model parameter</p>
447<table class="docutils field-list" frame="void" rules="none">
448<col class="field-name" />
449<col class="field-body" />
450<tbody valign="top">
[c0d873f]451<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
[512573a]452<li><strong>parameter</strong> &#8211; name of the parameter [string]</li>
453<li><strong>dispersion</strong> &#8211; dispersion object of type DispersionModel</li>
454</ul>
455</td>
456</tr>
457</tbody>
458</table>
459</dd></dl>
460
461</dd></dl>
462
463<dl class="function">
464<dt id="sans.models.ReflAdvModel.create_ReflAdvModel">
465<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>
466<dd></dd></dl>
467
468</div>
469</div>
470
471
472          </div>
473        </div>
474      </div>
475      <div class="sphinxsidebar">
476        <div class="sphinxsidebarwrapper">
477  <h3><a href="../index.html">Table Of Contents</a></h3>
478  <ul>
479<li><a class="reference internal" href="#">ReflAdvModel</a><ul>
[c0d873f]480<li><a class="reference internal" href="#sans-models-refladvmodel"><tt class="docutils literal"><span class="pre">sans.models.ReflAdvModel</span></tt></a></li>
[512573a]481</ul>
482</li>
483</ul>
484
485  <h4>Previous topic</h4>
486  <p class="topless"><a href="qsmearing.html"
487                        title="previous chapter">qsmearing</a></p>
488  <h4>Next topic</h4>
489  <p class="topless"><a href="ReflectivityIIModel.html"
490                        title="next chapter">ReflectivityIIModel</a></p>
491  <h3>This Page</h3>
492  <ul class="this-page-menu">
493    <li><a href="../_sources/api/ReflAdvModel.txt"
494           rel="nofollow">Show Source</a></li>
495  </ul>
496<div id="searchbox" style="display: none">
497  <h3>Quick search</h3>
498    <form class="search" action="../search.html" method="get">
[c0d873f]499      <input type="text" name="q" />
[512573a]500      <input type="submit" value="Go" />
501      <input type="hidden" name="check_keywords" value="yes" />
502      <input type="hidden" name="area" value="default" />
503    </form>
504    <p class="searchtip" style="font-size: 90%">
505    Enter search terms or a module, class or function name.
506    </p>
507</div>
508<script type="text/javascript">$('#searchbox').show(0);</script>
509        </div>
510      </div>
511      <div class="clearer"></div>
512    </div>
513    <div class="related">
514      <h3>Navigation</h3>
515      <ul>
516        <li class="right" style="margin-right: 10px">
517          <a href="../genindex.html" title="General Index"
518             >index</a></li>
519        <li class="right" >
520          <a href="../py-modindex.html" title="Python Module Index"
521             >modules</a> |</li>
522        <li class="right" >
523          <a href="ReflectivityIIModel.html" title="ReflectivityIIModel"
524             >next</a> |</li>
525        <li class="right" >
526          <a href="qsmearing.html" title="qsmearing"
527             >previous</a> |</li>
[c0d873f]528        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li>
[512573a]529          <li><a href="index.html" >Reference</a> &raquo;</li> 
530      </ul>
531    </div>
532    <div class="footer">
533        &copy; Copyright 2010, sans group.
[c0d873f]534      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
[512573a]535    </div>
536  </body>
537</html>
Note: See TracBrowser for help on using the repository browser.