source: sasview/sansmodels/docs/sphinx/_build/html/api/CylinderModel.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@…>, 15 years ago

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