source: sasview/sansmodels/docs/sphinx/html/api/NewCylinderModel.html @ dbdff5e

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 dbdff5e was c0d873f, checked in by Gervaise Alina <gervyh@…>, 13 years ago

edit docs for models
  • Property mode set to 100644
File size: 19.5 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
7<html xmlns="http://www.w3.org/1999/xhtml">
8  <head>
9    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10   
11    <title>NewCylinderModel &mdash; sansmodels 0.1.0 documentation</title>
12   
13    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
14    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
15   
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>
28    <link rel="top" title="sansmodels 0.1.0 documentation" href="../index.html" />
29    <link rel="up" title="Reference" href="index.html" />
30    <link rel="next" title="NoStructure" href="NoStructure.html" />
31    <link rel="prev" title="MultiShellModel" href="MultiShellModel.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="NoStructure.html" title="NoStructure"
45             accesskey="N">next</a> |</li>
46        <li class="right" >
47          <a href="MultiShellModel.html" title="MultiShellModel"
48             accesskey="P">previous</a> |</li>
49        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li>
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="newcylindermodel">
60<h1>NewCylinderModel<a class="headerlink" href="#newcylindermodel" title="Permalink to this headline">¶</a></h1>
61<div class="section" id="sans-models-newcylindermodel">
62<h2><a class="reference internal" href="#module-sans.models.NewCylinderModel" title="sans.models.NewCylinderModel"><tt class="xref py py-mod docutils literal"><span class="pre">sans.models.NewCylinderModel</span></tt></a><a class="headerlink" href="#sans-models-newcylindermodel" title="Permalink to this headline">¶</a></h2>
63<span class="target" id="module-sans.models.NewCylinderModel"></span><p>This software was developed by the University of Tennessee as part of the
64Distributed Data Analysis of Neutron Scattering Experiments (DANSE)
65project funded by the US National Science Foundation.</p>
66<p>If you use DANSE applications to do scientific research that leads to
67publication, we ask that you acknowledge the use of the software with the
68following sentence:</p>
69<p>&#8220;This work benefited from DANSE software developed under NSF award DMR-0520547.&#8221;</p>
70<p>copyright 2008, University of Tennessee</p>
71<dl class="class">
72<dt id="sans.models.NewCylinderModel.CylinderModel">
73<em class="property">class </em><tt class="descclassname">sans.models.NewCylinderModel.</tt><tt class="descname">CylinderModel</tt><a class="headerlink" href="#sans.models.NewCylinderModel.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="BaseModel.html#sans.models.BaseModel.BaseModel" title="sans.models.BaseModel.BaseModel"><tt class="xref py py-class docutils literal"><span class="pre">sans.models.BaseModel.BaseModel</span></tt></a></p>
75<p>Class that evaluates a CylinderModel model.
76This file was auto-generated from ../c_extensions/cylinder.h.
77Refer to that file and the structure it contains
78for details of the model.
79List of default parameters:</p>
80<blockquote>
81<div>scale           = 1.0
82radius          = 20.0 A
83length          = 400.0 A
84contrast        = 3e-006 A-2
85background      = 0.0 cm-1
86cyl_theta       = 1.0 rad
87cyl_phi         = 1.0 rad</div></blockquote>
88<dl class="method">
89<dt id="sans.models.NewCylinderModel.CylinderModel.__add__">
90<tt class="descname">__add__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__add__" title="Permalink to this definition">¶</a></dt>
91<dd></dd></dl>
92
93<dl class="method">
94<dt id="sans.models.NewCylinderModel.CylinderModel.__call__">
95<tt class="descname">__call__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__call__" title="Permalink to this definition">¶</a></dt>
96<dd><p>Evaluate the model. Equivalent to runXY(x)</p>
97<table class="docutils field-list" frame="void" rules="none">
98<col class="field-name" />
99<col class="field-body" />
100<tbody valign="top">
101<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><strong>x</strong> &#8211; input value</td>
102</tr>
103<tr class="field-even field"><th class="field-name">Returns:</th><td class="field-body">value of the model</td>
104</tr>
105</tbody>
106</table>
107</dd></dl>
108
109<dl class="attribute">
110<dt id="sans.models.NewCylinderModel.CylinderModel.__class__">
111<tt class="descname">__class__</tt><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__class__" title="Permalink to this definition">¶</a></dt>
112<dd><p>alias of <tt class="xref py py-class docutils literal"><span class="pre">type</span></tt></p>
113</dd></dl>
114
115<dl class="attribute">
116<dt id="sans.models.NewCylinderModel.CylinderModel.__delattr__">
117<tt class="descname">__delattr__</tt><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__delattr__" title="Permalink to this definition">¶</a></dt>
118<dd><p>x.__delattr__(&#8216;name&#8217;) &lt;==&gt; del x.name</p>
119</dd></dl>
120
121<dl class="attribute">
122<dt id="sans.models.NewCylinderModel.CylinderModel.__dict__">
123<tt class="descname">__dict__</tt><em class="property"> = &lt;dictproxy object at 0x0279BE50&gt;</em><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__dict__" title="Permalink to this definition">¶</a></dt>
124<dd></dd></dl>
125
126<dl class="method">
127<dt id="sans.models.NewCylinderModel.CylinderModel.__div__">
128<tt class="descname">__div__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__div__" title="Permalink to this definition">¶</a></dt>
129<dd></dd></dl>
130
131<dl class="attribute">
132<dt id="sans.models.NewCylinderModel.CylinderModel.__getattribute__">
133<tt class="descname">__getattribute__</tt><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__getattribute__" title="Permalink to this definition">¶</a></dt>
134<dd><p>x.__getattribute__(&#8216;name&#8217;) &lt;==&gt; x.name</p>
135</dd></dl>
136
137<dl class="attribute">
138<dt id="sans.models.NewCylinderModel.CylinderModel.__hash__">
139<tt class="descname">__hash__</tt><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__hash__" title="Permalink to this definition">¶</a></dt>
140<dd><p>x.__hash__() &lt;==&gt; hash(x)</p>
141</dd></dl>
142
143<dl class="method">
144<dt id="sans.models.NewCylinderModel.CylinderModel.__init__">
145<tt class="descname">__init__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__init__" title="Permalink to this definition">¶</a></dt>
146<dd><p>Initialization</p>
147</dd></dl>
148
149<dl class="attribute">
150<dt id="sans.models.NewCylinderModel.CylinderModel.__module__">
151<tt class="descname">__module__</tt><em class="property"> = 'sans.models.NewCylinderModel'</em><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__module__" title="Permalink to this definition">¶</a></dt>
152<dd></dd></dl>
153
154<dl class="method">
155<dt id="sans.models.NewCylinderModel.CylinderModel.__mul__">
156<tt class="descname">__mul__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__mul__" title="Permalink to this definition">¶</a></dt>
157<dd></dd></dl>
158
159<dl class="staticmethod">
160<dt id="sans.models.NewCylinderModel.CylinderModel.__new__">
161<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.NewCylinderModel.CylinderModel.__new__" title="Permalink to this definition">¶</a></dt>
162<dd></dd></dl>
163
164<dl class="method">
165<dt id="sans.models.NewCylinderModel.CylinderModel.__reduce__">
166<tt class="descname">__reduce__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__reduce__" title="Permalink to this definition">¶</a></dt>
167<dd><p>helper for pickle</p>
168</dd></dl>
169
170<dl class="method">
171<dt id="sans.models.NewCylinderModel.CylinderModel.__reduce_ex__">
172<tt class="descname">__reduce_ex__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__reduce_ex__" title="Permalink to this definition">¶</a></dt>
173<dd><p>helper for pickle</p>
174</dd></dl>
175
176<dl class="attribute">
177<dt id="sans.models.NewCylinderModel.CylinderModel.__repr__">
178<tt class="descname">__repr__</tt><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__repr__" title="Permalink to this definition">¶</a></dt>
179<dd><p>x.__repr__() &lt;==&gt; repr(x)</p>
180</dd></dl>
181
182<dl class="attribute">
183<dt id="sans.models.NewCylinderModel.CylinderModel.__setattr__">
184<tt class="descname">__setattr__</tt><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__setattr__" title="Permalink to this definition">¶</a></dt>
185<dd><p>x.__setattr__(&#8216;name&#8217;, value) &lt;==&gt; x.name = value</p>
186</dd></dl>
187
188<dl class="attribute">
189<dt id="sans.models.NewCylinderModel.CylinderModel.__str__">
190<tt class="descname">__str__</tt><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__str__" title="Permalink to this definition">¶</a></dt>
191<dd><p>x.__str__() &lt;==&gt; str(x)</p>
192</dd></dl>
193
194<dl class="method">
195<dt id="sans.models.NewCylinderModel.CylinderModel.__sub__">
196<tt class="descname">__sub__</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__sub__" title="Permalink to this definition">¶</a></dt>
197<dd></dd></dl>
198
199<dl class="attribute">
200<dt id="sans.models.NewCylinderModel.CylinderModel.__weakref__">
201<tt class="descname">__weakref__</tt><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.__weakref__" title="Permalink to this definition">¶</a></dt>
202<dd><p>list of weak references to the object (if defined)</p>
203</dd></dl>
204
205<dl class="method">
206<dt id="sans.models.NewCylinderModel.CylinderModel.calculate_ER">
207<tt class="descname">calculate_ER</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.calculate_ER" title="Permalink to this definition">¶</a></dt>
208<dd><p>Evaluate the model at a given Q or Q, phi</p>
209</dd></dl>
210
211<dl class="method">
212<dt id="sans.models.NewCylinderModel.CylinderModel.clone">
213<tt class="descname">clone</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.clone" title="Permalink to this definition">¶</a></dt>
214<dd><p>Return a identical copy of self</p>
215</dd></dl>
216
217<dl class="attribute">
218<dt id="sans.models.NewCylinderModel.CylinderModel.dispersion">
219<tt class="descname">dispersion</tt><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.dispersion" title="Permalink to this definition">¶</a></dt>
220<dd><p>Dispersion parameters</p>
221</dd></dl>
222
223<dl class="method">
224<dt id="sans.models.NewCylinderModel.CylinderModel.evalDistribution">
225<tt class="descname">evalDistribution</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.evalDistribution" title="Permalink to this definition">¶</a></dt>
226<dd><p>Evaluate the model at a given Q or Qx, Qy vector</p>
227</dd></dl>
228
229<dl class="method">
230<dt id="sans.models.NewCylinderModel.CylinderModel.getParam">
231<tt class="descname">getParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.getParam" title="Permalink to this definition">¶</a></dt>
232<dd><p>Set the value of a model parameter</p>
233<table class="docutils field-list" frame="void" rules="none">
234<col class="field-name" />
235<col class="field-body" />
236<tbody valign="top">
237<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
238<li><strong>name</strong> &#8211; name of the parameter</li>
239<li><strong>value</strong> &#8211; value of the parameter</li>
240</ul>
241</td>
242</tr>
243</tbody>
244</table>
245</dd></dl>
246
247<dl class="method">
248<dt id="sans.models.NewCylinderModel.CylinderModel.getParamList">
249<tt class="descname">getParamList</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.getParamList" title="Permalink to this definition">¶</a></dt>
250<dd><p>Return a list of all available parameters for the model</p>
251</dd></dl>
252
253<dl class="method">
254<dt id="sans.models.NewCylinderModel.CylinderModel.getParamListWithToken">
255<tt class="descname">getParamListWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt>
256<dd></dd></dl>
257
258<dl class="method">
259<dt id="sans.models.NewCylinderModel.CylinderModel.getParamWithToken">
260<tt class="descname">getParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.getParamWithToken" title="Permalink to this definition">¶</a></dt>
261<dd></dd></dl>
262
263<dl class="attribute">
264<dt id="sans.models.NewCylinderModel.CylinderModel.log">
265<tt class="descname">log</tt><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.log" title="Permalink to this definition">¶</a></dt>
266<dd><p>Log</p>
267</dd></dl>
268
269<dl class="attribute">
270<dt id="sans.models.NewCylinderModel.CylinderModel.name">
271<tt class="descname">name</tt><em class="property"> = 'BaseModel'</em><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.name" title="Permalink to this definition">¶</a></dt>
272<dd></dd></dl>
273
274<dl class="attribute">
275<dt id="sans.models.NewCylinderModel.CylinderModel.params">
276<tt class="descname">params</tt><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.params" title="Permalink to this definition">¶</a></dt>
277<dd><p>Parameters</p>
278</dd></dl>
279
280<dl class="method">
281<dt id="sans.models.NewCylinderModel.CylinderModel.reset">
282<tt class="descname">reset</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.reset" title="Permalink to this definition">¶</a></dt>
283<dd><p>Reset pair correlation</p>
284</dd></dl>
285
286<dl class="method">
287<dt id="sans.models.NewCylinderModel.CylinderModel.run">
288<tt class="descname">run</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.run" title="Permalink to this definition">¶</a></dt>
289<dd><p>Evaluate the model
290&#64;param x: input q, or [q,phi]
291&#64;return: scattering function P(q)</p>
292</dd></dl>
293
294<dl class="method">
295<dt id="sans.models.NewCylinderModel.CylinderModel.runXY">
296<tt class="descname">runXY</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.runXY" title="Permalink to this definition">¶</a></dt>
297<dd><p>Evaluate the model in cartesian coordinates
298&#64;param x: input q, or [qx, qy]
299&#64;return: scattering function P(q)</p>
300</dd></dl>
301
302<dl class="method">
303<dt id="sans.models.NewCylinderModel.CylinderModel.setParam">
304<tt class="descname">setParam</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.setParam" title="Permalink to this definition">¶</a></dt>
305<dd><p>Set the value of a model parameter</p>
306<table class="docutils field-list" frame="void" rules="none">
307<col class="field-name" />
308<col class="field-body" />
309<tbody valign="top">
310<tr class="field-odd field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
311<li><strong>name</strong> &#8211; name of the parameter</li>
312<li><strong>value</strong> &#8211; value of the parameter</li>
313</ul>
314</td>
315</tr>
316</tbody>
317</table>
318</dd></dl>
319
320<dl class="method">
321<dt id="sans.models.NewCylinderModel.CylinderModel.setParamWithToken">
322<tt class="descname">setParamWithToken</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.setParamWithToken" title="Permalink to this definition">¶</a></dt>
323<dd></dd></dl>
324
325<dl class="method">
326<dt id="sans.models.NewCylinderModel.CylinderModel.set_dispersion">
327<tt class="descname">set_dispersion</tt><big>(</big><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.set_dispersion" title="Permalink to this definition">¶</a></dt>
328<dd><p>Set the dispersion object for a model parameter
329&#64;param parameter: name of the parameter [string]
330&#64;dispersion: dispersion object of type DispersionModel</p>
331</dd></dl>
332
333</dd></dl>
334
335</div>
336</div>
337
338
339          </div>
340        </div>
341      </div>
342      <div class="sphinxsidebar">
343        <div class="sphinxsidebarwrapper">
344  <h3><a href="../index.html">Table Of Contents</a></h3>
345  <ul>
346<li><a class="reference internal" href="#">NewCylinderModel</a><ul>
347<li><a class="reference internal" href="#sans-models-newcylindermodel"><tt class="docutils literal"><span class="pre">sans.models.NewCylinderModel</span></tt></a></li>
348</ul>
349</li>
350</ul>
351
352  <h4>Previous topic</h4>
353  <p class="topless"><a href="MultiShellModel.html"
354                        title="previous chapter">MultiShellModel</a></p>
355  <h4>Next topic</h4>
356  <p class="topless"><a href="NoStructure.html"
357                        title="next chapter">NoStructure</a></p>
358  <h3>This Page</h3>
359  <ul class="this-page-menu">
360    <li><a href="../_sources/api/NewCylinderModel.txt"
361           rel="nofollow">Show Source</a></li>
362  </ul>
363<div id="searchbox" style="display: none">
364  <h3>Quick search</h3>
365    <form class="search" action="../search.html" method="get">
366      <input type="text" name="q" />
367      <input type="submit" value="Go" />
368      <input type="hidden" name="check_keywords" value="yes" />
369      <input type="hidden" name="area" value="default" />
370    </form>
371    <p class="searchtip" style="font-size: 90%">
372    Enter search terms or a module, class or function name.
373    </p>
374</div>
375<script type="text/javascript">$('#searchbox').show(0);</script>
376        </div>
377      </div>
378      <div class="clearer"></div>
379    </div>
380    <div class="related">
381      <h3>Navigation</h3>
382      <ul>
383        <li class="right" style="margin-right: 10px">
384          <a href="../genindex.html" title="General Index"
385             >index</a></li>
386        <li class="right" >
387          <a href="../py-modindex.html" title="Python Module Index"
388             >modules</a> |</li>
389        <li class="right" >
390          <a href="NoStructure.html" title="NoStructure"
391             >next</a> |</li>
392        <li class="right" >
393          <a href="MultiShellModel.html" title="MultiShellModel"
394             >previous</a> |</li>
395        <li><a href="../index.html">sansmodels 0.1.0 documentation</a> &raquo;</li>
396          <li><a href="index.html" >Reference</a> &raquo;</li> 
397      </ul>
398    </div>
399    <div class="footer">
400        &copy; Copyright 2010, sans group.
401      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.
402    </div>
403  </body>
404</html>
Note: See TracBrowser for help on using the repository browser.