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

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

HTML folder generated by Sphinx
  • Property mode set to 100644
File size: 13.0 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>NewCylinderModel &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="NoStructure" href="NoStructure.html" />
28    <link rel="prev" title="MultiShellModel" href="MultiShellModel.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="NoStructure.html" title="NoStructure"
42             accesskey="N">next</a> |</li>
43        <li class="right" >
44          <a href="MultiShellModel.html" title="MultiShellModel"
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="newcylindermodel">
57<h1>NewCylinderModel<a class="headerlink" href="#newcylindermodel" title="Permalink to this headline">¶</a></h1>
58<div class="section" id="module-sans.models.NewCylinderModel">
59<span id="sans-models-newcylindermodel"></span><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="#module-sans.models.NewCylinderModel" title="Permalink to this headline">¶</a></h2>
60<p>This software was developed by the University of Tennessee as part of the
61Distributed Data Analysis of Neutron Scattering Experiments (DANSE)
62project funded by the US National Science Foundation.</p>
63<p>If you use DANSE applications to do scientific research that leads to
64publication, we ask that you acknowledge the use of the software with the
65following sentence:</p>
66<p>&#8220;This work benefited from DANSE software developed under NSF award DMR-0520547.&#8221;</p>
67<p>copyright 2008, University of Tennessee</p>
68<dl class="class">
69<dt id="sans.models.NewCylinderModel.CylinderModel">
70<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>
71<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>
72<p>Class that evaluates a CylinderModel model.
73This file was auto-generated from ../c_extensions/cylinder.h.
74Refer to that file and the structure it contains
75for details of the model.
76List of default parameters:</p>
77<blockquote>
78<div>scale           = 1.0
79radius          = 20.0 A
80length          = 400.0 A
81contrast        = 3e-006 A-2
82background      = 0.0 cm-1
83cyl_theta       = 1.0 rad
84cyl_phi         = 1.0 rad</div></blockquote>
85<dl class="attribute">
86<dt id="sans.models.NewCylinderModel.CylinderModel.calculate_ER">
87<tt class="descname">calculate_ER</tt><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.calculate_ER" title="Permalink to this definition">¶</a></dt>
88<dd><p>Evaluate the model at a given Q or Q, phi</p>
89</dd></dl>
90
91<dl class="method">
92<dt id="sans.models.NewCylinderModel.CylinderModel.clone">
93<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>
94<dd><p>Return a identical copy of self</p>
95</dd></dl>
96
97<dl class="attribute">
98<dt id="sans.models.NewCylinderModel.CylinderModel.dispersion">
99<tt class="descname">dispersion</tt><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.dispersion" title="Permalink to this definition">¶</a></dt>
100<dd><p>Dispersion parameters</p>
101</dd></dl>
102
103<dl class="attribute">
104<dt id="sans.models.NewCylinderModel.CylinderModel.evalDistribution">
105<tt class="descname">evalDistribution</tt><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.evalDistribution" title="Permalink to this definition">¶</a></dt>
106<dd><p>Evaluate the model at a given Q or Qx, Qy vector</p>
107</dd></dl>
108
109<dl class="method">
110<dt id="sans.models.NewCylinderModel.CylinderModel.getParam">
111<tt class="descname">getParam</tt><big>(</big><em>name</em><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.getParam" title="Permalink to this definition">¶</a></dt>
112<dd><p>Set the value of a model parameter</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"><ul class="first last simple">
118<li><strong>name</strong> &#8211; name of the parameter</li>
119<li><strong>value</strong> &#8211; value of the parameter</li>
120</ul>
121</td>
122</tr>
123</tbody>
124</table>
125</dd></dl>
126
127<dl class="method">
128<dt id="sans.models.NewCylinderModel.CylinderModel.getParamList">
129<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>
130<dd><p>Return a list of all available parameters for the model</p>
131</dd></dl>
132
133<dl class="method">
134<dt id="sans.models.NewCylinderModel.CylinderModel.getParamListWithToken">
135<tt class="descname">getParamListWithToken</tt><big>(</big><em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.getParamListWithToken" title="Permalink to this definition">¶</a></dt>
136<dd></dd></dl>
137
138<dl class="method">
139<dt id="sans.models.NewCylinderModel.CylinderModel.getParamWithToken">
140<tt class="descname">getParamWithToken</tt><big>(</big><em>name</em>, <em>token</em>, <em>member</em><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.getParamWithToken" title="Permalink to this definition">¶</a></dt>
141<dd></dd></dl>
142
143<dl class="attribute">
144<dt id="sans.models.NewCylinderModel.CylinderModel.log">
145<tt class="descname">log</tt><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.log" title="Permalink to this definition">¶</a></dt>
146<dd><p>Log</p>
147</dd></dl>
148
149<dl class="attribute">
150<dt id="sans.models.NewCylinderModel.CylinderModel.params">
151<tt class="descname">params</tt><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.params" title="Permalink to this definition">¶</a></dt>
152<dd><p>Parameters</p>
153</dd></dl>
154
155<dl class="attribute">
156<dt id="sans.models.NewCylinderModel.CylinderModel.reset">
157<tt class="descname">reset</tt><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.reset" title="Permalink to this definition">¶</a></dt>
158<dd><p>Reset pair correlation</p>
159</dd></dl>
160
161<dl class="method">
162<dt id="sans.models.NewCylinderModel.CylinderModel.run">
163<tt class="descname">run</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.run" title="Permalink to this definition">¶</a></dt>
164<dd><p>Evaluate the model
165&#64;param x: input q, or [q,phi]
166&#64;return: scattering function P(q)</p>
167</dd></dl>
168
169<dl class="method">
170<dt id="sans.models.NewCylinderModel.CylinderModel.runXY">
171<tt class="descname">runXY</tt><big>(</big><em>x=0.0</em><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.runXY" title="Permalink to this definition">¶</a></dt>
172<dd><p>Evaluate the model in cartesian coordinates
173&#64;param x: input q, or [qx, qy]
174&#64;return: scattering function P(q)</p>
175</dd></dl>
176
177<dl class="method">
178<dt id="sans.models.NewCylinderModel.CylinderModel.setParam">
179<tt class="descname">setParam</tt><big>(</big><em>name</em>, <em>value</em><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.setParam" title="Permalink to this definition">¶</a></dt>
180<dd><p>Set the value of a model parameter</p>
181<table class="docutils field-list" frame="void" rules="none">
182<col class="field-name" />
183<col class="field-body" />
184<tbody valign="top">
185<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
186<li><strong>name</strong> &#8211; name of the parameter</li>
187<li><strong>value</strong> &#8211; value of the parameter</li>
188</ul>
189</td>
190</tr>
191</tbody>
192</table>
193</dd></dl>
194
195<dl class="method">
196<dt id="sans.models.NewCylinderModel.CylinderModel.setParamWithToken">
197<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.NewCylinderModel.CylinderModel.setParamWithToken" title="Permalink to this definition">¶</a></dt>
198<dd></dd></dl>
199
200<dl class="method">
201<dt id="sans.models.NewCylinderModel.CylinderModel.set_dispersion">
202<tt class="descname">set_dispersion</tt><big>(</big><em>parameter</em>, <em>dispersion</em><big>)</big><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.set_dispersion" title="Permalink to this definition">¶</a></dt>
203<dd><p>Set the dispersion object for a model parameter
204&#64;param parameter: name of the parameter [string]
205&#64;dispersion: dispersion object of type DispersionModel</p>
206</dd></dl>
207
208</dd></dl>
209
210</div>
211</div>
212
213
214          </div>
215        </div>
216      </div>
217      <div class="sphinxsidebar">
218        <div class="sphinxsidebarwrapper">
219  <h3><a href="../index.html">Table Of Contents</a></h3>
220  <ul>
221<li><a class="reference internal" href="#">NewCylinderModel</a><ul>
222<li><a class="reference internal" href="#module-sans.models.NewCylinderModel"><tt class="docutils literal"><span class="pre">sans.models.NewCylinderModel</span></tt></a></li>
223</ul>
224</li>
225</ul>
226
227  <h4>Previous topic</h4>
228  <p class="topless"><a href="MultiShellModel.html"
229                        title="previous chapter">MultiShellModel</a></p>
230  <h4>Next topic</h4>
231  <p class="topless"><a href="NoStructure.html"
232                        title="next chapter">NoStructure</a></p>
233  <h3>This Page</h3>
234  <ul class="this-page-menu">
235    <li><a href="../_sources/api/NewCylinderModel.txt"
236           rel="nofollow">Show Source</a></li>
237  </ul>
238<div id="searchbox" style="display: none">
239  <h3>Quick search</h3>
240    <form class="search" action="../search.html" method="get">
241      <input type="text" name="q" size="18" />
242      <input type="submit" value="Go" />
243      <input type="hidden" name="check_keywords" value="yes" />
244      <input type="hidden" name="area" value="default" />
245    </form>
246    <p class="searchtip" style="font-size: 90%">
247    Enter search terms or a module, class or function name.
248    </p>
249</div>
250<script type="text/javascript">$('#searchbox').show(0);</script>
251        </div>
252      </div>
253      <div class="clearer"></div>
254    </div>
255    <div class="related">
256      <h3>Navigation</h3>
257      <ul>
258        <li class="right" style="margin-right: 10px">
259          <a href="../genindex.html" title="General Index"
260             >index</a></li>
261        <li class="right" >
262          <a href="../py-modindex.html" title="Python Module Index"
263             >modules</a> |</li>
264        <li class="right" >
265          <a href="NoStructure.html" title="NoStructure"
266             >next</a> |</li>
267        <li class="right" >
268          <a href="MultiShellModel.html" title="MultiShellModel"
269             >previous</a> |</li>
270        <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li>
271          <li><a href="index.html" >Reference</a> &raquo;</li> 
272      </ul>
273    </div>
274    <div class="footer">
275        &copy; Copyright 2010, sans group.
276      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.7.
277    </div>
278  </body>
279</html>
Note: See TracBrowser for help on using the repository browser.