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

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

HTML folder generated by Sphinx
  • Property mode set to 100644
File size: 12.8 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>ReflectivityModel &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="ReflModel" href="ReflModel.html" />
28    <link rel="prev" title="ReflectivityIIModel" href="ReflectivityIIModel.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="ReflModel.html" title="ReflModel"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="ReflectivityIIModel.html" title="ReflectivityIIModel"
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="reflectivitymodel">
57<h1>ReflectivityModel<a class="headerlink" href="#reflectivitymodel" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.models.ReflectivityModel">
59<span id="sans-models-reflectivitymodel"></span><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="#module-sans.models.ReflectivityModel" title="Permalink to this headline">¶</a></h2>
60<dl class="class">
61<dt id="sans.models.ReflectivityModel.ReflectivityModel">
62<em class="property">class </em><tt class="descclassname">sans.models.ReflectivityModel.</tt><tt class="descname">ReflectivityModel</tt><big>(</big><em>multfactor=1</em><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel" title="Permalink to this definition">¶</a></dt>
63<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>
64<p>This multi-model is based on Parratt formalism and provides the capability
65of changing the number of layers between 0 and 10.</p>
66<dl class="method">
67<dt id="sans.models.ReflectivityModel.ReflectivityModel.calculate_ER">
68<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>
69<dd></dd></dl>
70
71<dl class="method">
72<dt id="sans.models.ReflectivityModel.ReflectivityModel.clone">
73<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>
74<dd><p>Returns a new object identical to the current object</p>
75</dd></dl>
76
77<dl class="method">
78<dt id="sans.models.ReflectivityModel.ReflectivityModel.evalDistribution">
79<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.ReflectivityModel.ReflectivityModel.evalDistribution" title="Permalink to this definition">¶</a></dt>
80<dd><p>Evaluate the model in cartesian coordinates</p>
81<p>: param x: input q[], or [qx[], qy[]]
82: return: scattering function P(q[])</p>
83</dd></dl>
84
85<dl class="method">
86<dt id="sans.models.ReflectivityModel.ReflectivityModel.getDispParamList">
87<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>
88<dd><p>Return a list of all available parameters for the model</p>
89</dd></dl>
90
91<dl class="method">
92<dt id="sans.models.ReflectivityModel.ReflectivityModel.getParam">
93<tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel.getParam" title="Permalink to this definition">¶</a></dt>
94<dd><p>Set the value of a model parameter</p>
95<table class="docutils field-list" frame="void" rules="none">
96<col class="field-name" />
97<col class="field-body" />
98<tbody valign="top">
99<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>name</strong> &#8211; name of the parameter</td>
100</tr>
101</tbody>
102</table>
103</dd></dl>
104
105<dl class="method">
106<dt id="sans.models.ReflectivityModel.ReflectivityModel.getParamList">
107<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>
108<dd><p>Return a list of all available parameters for the model</p>
109</dd></dl>
110
111<dl class="method">
112<dt id="sans.models.ReflectivityModel.ReflectivityModel.getParamListWithToken">
113<tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt>
114<dd></dd></dl>
115
116<dl class="method">
117<dt id="sans.models.ReflectivityModel.ReflectivityModel.getParamWithToken">
118<tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel.getParamWithToken" title="Permalink to this definition">¶</a></dt>
119<dd></dd></dl>
120
121<dl class="method">
122<dt id="sans.models.ReflectivityModel.ReflectivityModel.getProfile">
123<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>
124<dd><p>Get SLD profile</p>
125<dl class="docutils">
126<dt>: return: (z, beta) where z is a list of depth of the transition points</dt>
127<dd>beta is a list of the corresponding SLD values</dd>
128</dl>
129</dd></dl>
130
131<dl class="method">
132<dt id="sans.models.ReflectivityModel.ReflectivityModel.is_fittable">
133<tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel.is_fittable" title="Permalink to this definition">¶</a></dt>
134<dd><p>Check if a given parameter is fittable or not</p>
135<table class="docutils field-list" frame="void" rules="none">
136<col class="field-name" />
137<col class="field-body" />
138<tbody valign="top">
139<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td>
140</tr>
141</tbody>
142</table>
143</dd></dl>
144
145<dl class="method">
146<dt id="sans.models.ReflectivityModel.ReflectivityModel.run">
147<tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel.run" title="Permalink to this definition">¶</a></dt>
148<dd><p>Evaluate the model</p>
149<table class="docutils field-list" frame="void" rules="none">
150<col class="field-name" />
151<col class="field-body" />
152<tbody valign="top">
153<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [q,phi]</td>
154</tr>
155<tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
156</tr>
157</tbody>
158</table>
159</dd></dl>
160
161<dl class="method">
162<dt id="sans.models.ReflectivityModel.ReflectivityModel.runXY">
163<tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel.runXY" title="Permalink to this definition">¶</a></dt>
164<dd><p>Evaluate the model</p>
165<p>: param x: input q-value (float or [float, float] as [qx, qy])
166: return: scattering function value</p>
167</dd></dl>
168
169<dl class="method">
170<dt id="sans.models.ReflectivityModel.ReflectivityModel.setParam">
171<tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel.setParam" title="Permalink to this definition">¶</a></dt>
172<dd><p>Set the value of a model parameter</p>
173<p>: param name: name of the parameter
174: param value: value of the parameter</p>
175</dd></dl>
176
177<dl class="method">
178<dt id="sans.models.ReflectivityModel.ReflectivityModel.setParamWithToken">
179<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.ReflectivityModel.ReflectivityModel.setParamWithToken" title="Permalink to this definition">¶</a></dt>
180<dd></dd></dl>
181
182<dl class="method">
183<dt id="sans.models.ReflectivityModel.ReflectivityModel.set_dispersion">
184<tt class="descname">set_dispersion</tt><big>(</big><em>parameter</em>, <em>dispersion</em><big>)</big><a class="headerlink" href="#sans.models.ReflectivityModel.ReflectivityModel.set_dispersion" title="Permalink to this definition">¶</a></dt>
185<dd><p>Set the dispersion object for a model parameter</p>
186<p>: param parameter: name of the parameter [string]
187:dispersion: dispersion object of type DispersionModel</p>
188</dd></dl>
189
190</dd></dl>
191
192</div>
193</div>
194
195
196          </div>
197        </div>
198      </div>
199      <div class="sphinxsidebar">
200        <div class="sphinxsidebarwrapper">
201  <h3><a href="../index.html">Table Of Contents</a></h3>
202  <ul>
203<li><a class="reference internal" href="#">ReflectivityModel</a><ul>
204<li><a class="reference internal" href="#module-sans.models.ReflectivityModel"><tt class="docutils literal"><span class="pre">sans.models.ReflectivityModel</span></tt></a></li>
205</ul>
206</li>
207</ul>
208
209  <h4>Previous topic</h4>
210  <p class="topless"><a href="ReflectivityIIModel.html"
211                        title="previous chapter">ReflectivityIIModel</a></p>
212  <h4>Next topic</h4>
213  <p class="topless"><a href="ReflModel.html"
214                        title="next chapter">ReflModel</a></p>
215  <h3>This Page</h3>
216  <ul class="this-page-menu">
217    <li><a href="../_sources/api/ReflectivityModel.txt"
218           rel="nofollow">Show Source</a></li>
219  </ul>
220<div id="searchbox" style="display: none">
221  <h3>Quick search</h3>
222    <form class="search" action="../search.html" method="get">
223      <input type="text" name="q" size="18" />
224      <input type="submit" value="Go" />
225      <input type="hidden" name="check_keywords" value="yes" />
226      <input type="hidden" name="area" value="default" />
227    </form>
228    <p class="searchtip" style="font-size: 90%">
229    Enter search terms or a module, class or function name.
230    </p>
231</div>
232<script type="text/javascript">$('#searchbox').show(0);</script>
233        </div>
234      </div>
235      <div class="clearer"></div>
236    </div>
237    <div class="related">
238      <h3>Navigation</h3>
239      <ul>
240        <li class="right" style="margin-right: 10px">
241          <a href="../genindex.html" title="General Index"
242             >index</a></li>
243        <li class="right" >
244          <a href="../py-modindex.html" title="Python Module Index"
245             >modules</a> |</li>
246        <li class="right" >
247          <a href="ReflModel.html" title="ReflModel"
248             >next</a> |</li>
249        <li class="right" >
250          <a href="ReflectivityIIModel.html" title="ReflectivityIIModel"
251             >previous</a> |</li>
252        <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li>
253          <li><a href="index.html" >Reference</a> &raquo;</li> 
254      </ul>
255    </div>
256    <div class="footer">
257        &copy; Copyright 2010, sans group.
258      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
259    </div>
260  </body>
261</html>
Note: See TracBrowser for help on using the repository browser.