source: sasview/sansmodels/docs/sphinx/html/api/DiamEllipFunc.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: 15.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>DiamEllipFunc &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="DisperseModel" href="DisperseModel.html" />
28    <link rel="prev" title="DiamCylFunc" href="DiamCylFunc.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="DisperseModel.html" title="DisperseModel"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="DiamCylFunc.html" title="DiamCylFunc"
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="diamellipfunc">
57<h1>DiamEllipFunc<a class="headerlink" href="#diamellipfunc" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.models.DiamEllipFunc">
59<span id="sans-models-diamellipfunc"></span><h2><a class="reference internal" href="#module-sans.models.DiamEllipFunc" title="sans.models.DiamEllipFunc"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.DiamEllipFunc</span></tt></a><a class="headerlink" href="#module-sans.models.DiamEllipFunc" 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_extensionsDiamEllip.h
67AND RE-RUN THE GENERATOR SCRIPT</td>
68</tr>
69</tbody>
70</table>
71<dl class="class">
72<dt id="sans.models.DiamEllipFunc.DiamEllipFunc">
73<em class="property">class </em><tt class="descclassname">sans.models.DiamEllipFunc.</tt><tt class="descname">DiamEllipFunc</tt><a class="headerlink" href="#sans.models.DiamEllipFunc.DiamEllipFunc" title="Permalink to this definition">¶</a></dt>
74<dd><p>Bases: <tt class="xref py py-class docutils literal"><span class="pre">CDiamEllipFunc</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>
75<p>Class that evaluates a DiamEllipFunc model.
76This file was auto-generated from ..c_extensionsDiamEllip.h.
77Refer to that file and the structure it contains
78for details of the model.
79List of default parameters:</p>
80<blockquote>
81<div>radius_a        = 20.0 A
82radius_b        = 400.0 A</div></blockquote>
83<dl class="method">
84<dt id="sans.models.DiamEllipFunc.DiamEllipFunc.calculate_ER">
85<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DiamEllipFunc.DiamEllipFunc.calculate_ER" title="Permalink to this definition">¶</a></dt>
86<dd><p>Calculate the effective radius for P(q)*S(q)</p>
87<table class="docutils field-list" frame="void" rules="none">
88<col class="field-name" />
89<col class="field-body" />
90<tbody valign="top">
91<tr class="field"><th class="field-name">Returns:</th><td class="field-body">the value of the effective radius</td>
92</tr>
93</tbody>
94</table>
95</dd></dl>
96
97<dl class="method">
98<dt id="sans.models.DiamEllipFunc.DiamEllipFunc.clone">
99<tt class="descname">clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DiamEllipFunc.DiamEllipFunc.clone" title="Permalink to this definition">¶</a></dt>
100<dd><p>Return a identical copy of self</p>
101</dd></dl>
102
103<dl class="attribute">
104<dt id="sans.models.DiamEllipFunc.DiamEllipFunc.dispersion">
105<tt class="descname">dispersion</tt><a class="headerlink" href="#sans.models.DiamEllipFunc.DiamEllipFunc.dispersion" title="Permalink to this definition">¶</a></dt>
106<dd><p>Dispersion parameters</p>
107</dd></dl>
108
109<dl class="method">
110<dt id="sans.models.DiamEllipFunc.DiamEllipFunc.evalDistribution">
111<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.DiamEllipFunc.DiamEllipFunc.evalDistribution" title="Permalink to this definition">¶</a></dt>
112<dd><p>Evaluate the model in cartesian coordinates</p>
113<table class="docutils field-list" frame="void" rules="none">
114<col class="field-name" />
115<col class="field-body" />
116<tbody valign="top">
117<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q[], or [qx[], qy[]]</td>
118</tr>
119<tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q[])</td>
120</tr>
121</tbody>
122</table>
123</dd></dl>
124
125<dl class="method">
126<dt id="sans.models.DiamEllipFunc.DiamEllipFunc.getDispParamList">
127<tt class="descname">getDispParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DiamEllipFunc.DiamEllipFunc.getDispParamList" title="Permalink to this definition">¶</a></dt>
128<dd><p>Return a list of all available parameters for the model</p>
129</dd></dl>
130
131<dl class="method">
132<dt id="sans.models.DiamEllipFunc.DiamEllipFunc.getParam">
133<tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.DiamEllipFunc.DiamEllipFunc.getParam" title="Permalink to this definition">¶</a></dt>
134<dd><p>Set the value of a model parameter</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>name</strong> &#8211; name of the parameter</td>
140</tr>
141</tbody>
142</table>
143</dd></dl>
144
145<dl class="method">
146<dt id="sans.models.DiamEllipFunc.DiamEllipFunc.getParamList">
147<tt class="descname">getParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DiamEllipFunc.DiamEllipFunc.getParamList" title="Permalink to this definition">¶</a></dt>
148<dd><p>Return a list of all available parameters for the model</p>
149</dd></dl>
150
151<dl class="method">
152<dt id="sans.models.DiamEllipFunc.DiamEllipFunc.getParamListWithToken">
153<tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.DiamEllipFunc.DiamEllipFunc.getParamListWithToken" title="Permalink to this definition">¶</a></dt>
154<dd></dd></dl>
155
156<dl class="method">
157<dt id="sans.models.DiamEllipFunc.DiamEllipFunc.getParamWithToken">
158<tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.DiamEllipFunc.DiamEllipFunc.getParamWithToken" title="Permalink to this definition">¶</a></dt>
159<dd></dd></dl>
160
161<dl class="method">
162<dt id="sans.models.DiamEllipFunc.DiamEllipFunc.is_fittable">
163<tt class="descname">is_fittable</tt><big>(</big><em>par_name</em><big>)</big><a class="headerlink" href="#sans.models.DiamEllipFunc.DiamEllipFunc.is_fittable" title="Permalink to this definition">¶</a></dt>
164<dd><p>Check if a given parameter is fittable or not</p>
165<table class="docutils field-list" frame="void" rules="none">
166<col class="field-name" />
167<col class="field-body" />
168<tbody valign="top">
169<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>par_name</strong> &#8211; the parameter name to check</td>
170</tr>
171</tbody>
172</table>
173</dd></dl>
174
175<dl class="attribute">
176<dt id="sans.models.DiamEllipFunc.DiamEllipFunc.log">
177<tt class="descname">log</tt><a class="headerlink" href="#sans.models.DiamEllipFunc.DiamEllipFunc.log" title="Permalink to this definition">¶</a></dt>
178<dd><p>Log</p>
179</dd></dl>
180
181<dl class="attribute">
182<dt id="sans.models.DiamEllipFunc.DiamEllipFunc.params">
183<tt class="descname">params</tt><a class="headerlink" href="#sans.models.DiamEllipFunc.DiamEllipFunc.params" title="Permalink to this definition">¶</a></dt>
184<dd><p>Parameters</p>
185</dd></dl>
186
187<dl class="attribute">
188<dt id="sans.models.DiamEllipFunc.DiamEllipFunc.reset">
189<tt class="descname">reset</tt><a class="headerlink" href="#sans.models.DiamEllipFunc.DiamEllipFunc.reset" title="Permalink to this definition">¶</a></dt>
190<dd><p>Reset pair correlation</p>
191</dd></dl>
192
193<dl class="method">
194<dt id="sans.models.DiamEllipFunc.DiamEllipFunc.run">
195<tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.DiamEllipFunc.DiamEllipFunc.run" title="Permalink to this definition">¶</a></dt>
196<dd><p>Evaluate the model</p>
197<table class="docutils field-list" frame="void" rules="none">
198<col class="field-name" />
199<col class="field-body" />
200<tbody valign="top">
201<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [q,phi]</td>
202</tr>
203<tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
204</tr>
205</tbody>
206</table>
207</dd></dl>
208
209<dl class="method">
210<dt id="sans.models.DiamEllipFunc.DiamEllipFunc.runXY">
211<tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.DiamEllipFunc.DiamEllipFunc.runXY" title="Permalink to this definition">¶</a></dt>
212<dd><p>Evaluate the model in cartesian coordinates</p>
213<table class="docutils field-list" frame="void" rules="none">
214<col class="field-name" />
215<col class="field-body" />
216<tbody valign="top">
217<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input q, or [qx, qy]</td>
218</tr>
219<tr class="field"><th class="field-name">Returns:</th><td class="field-body">scattering function P(q)</td>
220</tr>
221</tbody>
222</table>
223</dd></dl>
224
225<dl class="method">
226<dt id="sans.models.DiamEllipFunc.DiamEllipFunc.setParam">
227<tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.DiamEllipFunc.DiamEllipFunc.setParam" title="Permalink to this definition">¶</a></dt>
228<dd><p>Set the value of a model parameter</p>
229<table class="docutils field-list" frame="void" rules="none">
230<col class="field-name" />
231<col class="field-body" />
232<tbody valign="top">
233<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
234<li><strong>name</strong> &#8211; name of the parameter</li>
235<li><strong>value</strong> &#8211; value of the parameter</li>
236</ul>
237</td>
238</tr>
239</tbody>
240</table>
241</dd></dl>
242
243<dl class="method">
244<dt id="sans.models.DiamEllipFunc.DiamEllipFunc.setParamWithToken">
245<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.DiamEllipFunc.DiamEllipFunc.setParamWithToken" title="Permalink to this definition">¶</a></dt>
246<dd></dd></dl>
247
248<dl class="method">
249<dt id="sans.models.DiamEllipFunc.DiamEllipFunc.set_dispersion">
250<tt class="descname">set_dispersion</tt><big>(</big><em>parameter</em>, <em>dispersion</em><big>)</big><a class="headerlink" href="#sans.models.DiamEllipFunc.DiamEllipFunc.set_dispersion" title="Permalink to this definition">¶</a></dt>
251<dd><p>Set the dispersion object for a model parameter</p>
252<table class="docutils field-list" frame="void" rules="none">
253<col class="field-name" />
254<col class="field-body" />
255<tbody valign="top">
256<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
257<li><strong>parameter</strong> &#8211; name of the parameter [string]</li>
258<li><strong>dispersion</strong> &#8211; dispersion object of type DispersionModel</li>
259</ul>
260</td>
261</tr>
262</tbody>
263</table>
264</dd></dl>
265
266</dd></dl>
267
268<dl class="function">
269<dt id="sans.models.DiamEllipFunc.create_DiamEllipFunc">
270<tt class="descclassname">sans.models.DiamEllipFunc.</tt><tt class="descname">create_DiamEllipFunc</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.DiamEllipFunc.create_DiamEllipFunc" title="Permalink to this definition">¶</a></dt>
271<dd></dd></dl>
272
273</div>
274</div>
275
276
277          </div>
278        </div>
279      </div>
280      <div class="sphinxsidebar">
281        <div class="sphinxsidebarwrapper">
282  <h3><a href="../index.html">Table Of Contents</a></h3>
283  <ul>
284<li><a class="reference internal" href="#">DiamEllipFunc</a><ul>
285<li><a class="reference internal" href="#module-sans.models.DiamEllipFunc"><tt class="docutils literal"><span class="pre">sans.models.DiamEllipFunc</span></tt></a></li>
286</ul>
287</li>
288</ul>
289
290  <h4>Previous topic</h4>
291  <p class="topless"><a href="DiamCylFunc.html"
292                        title="previous chapter">DiamCylFunc</a></p>
293  <h4>Next topic</h4>
294  <p class="topless"><a href="DisperseModel.html"
295                        title="next chapter">DisperseModel</a></p>
296  <h3>This Page</h3>
297  <ul class="this-page-menu">
298    <li><a href="../_sources/api/DiamEllipFunc.txt"
299           rel="nofollow">Show Source</a></li>
300  </ul>
301<div id="searchbox" style="display: none">
302  <h3>Quick search</h3>
303    <form class="search" action="../search.html" method="get">
304      <input type="text" name="q" size="18" />
305      <input type="submit" value="Go" />
306      <input type="hidden" name="check_keywords" value="yes" />
307      <input type="hidden" name="area" value="default" />
308    </form>
309    <p class="searchtip" style="font-size: 90%">
310    Enter search terms or a module, class or function name.
311    </p>
312</div>
313<script type="text/javascript">$('#searchbox').show(0);</script>
314        </div>
315      </div>
316      <div class="clearer"></div>
317    </div>
318    <div class="related">
319      <h3>Navigation</h3>
320      <ul>
321        <li class="right" style="margin-right: 10px">
322          <a href="../genindex.html" title="General Index"
323             >index</a></li>
324        <li class="right" >
325          <a href="../py-modindex.html" title="Python Module Index"
326             >modules</a> |</li>
327        <li class="right" >
328          <a href="DisperseModel.html" title="DisperseModel"
329             >next</a> |</li>
330        <li class="right" >
331          <a href="DiamCylFunc.html" title="DiamCylFunc"
332             >previous</a> |</li>
333        <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li>
334          <li><a href="index.html" >Reference</a> &raquo;</li> 
335      </ul>
336    </div>
337    <div class="footer">
338        &copy; Copyright 2010, sans group.
339      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
340    </div>
341  </body>
342</html>
Note: See TracBrowser for help on using the repository browser.