source: sasview/sansmodels/docs/sphinx/_build/html/api/EllipticalCylinderModel.html @ b94945d

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 b94945d was 79ac6f8, checked in by Gervaise Alina <gervyh@…>, 14 years ago

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