source: sasview/sansmodels/docs/sphinx/_build/html/api/NewCylinderModel.html @ 5062bbf

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

working on documentation
  • Property mode set to 100644
File size: 12.8 KB
RevLine 
[79ac6f8]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"><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>
78scale           = 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</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>Evaluate the model at a given Q or Q, phi</dd></dl>
89
90<dl class="method">
91<dt id="sans.models.NewCylinderModel.CylinderModel.clone">
92<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>
93<dd>Return a identical copy of self</dd></dl>
94
95<dl class="attribute">
96<dt id="sans.models.NewCylinderModel.CylinderModel.dispersion">
97<tt class="descname">dispersion</tt><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.dispersion" title="Permalink to this definition">¶</a></dt>
98<dd>Dispersion parameters</dd></dl>
99
100<dl class="attribute">
101<dt id="sans.models.NewCylinderModel.CylinderModel.evalDistribution">
102<tt class="descname">evalDistribution</tt><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.evalDistribution" title="Permalink to this definition">¶</a></dt>
103<dd>Evaluate the model at a given Q or Qx, Qy vector</dd></dl>
104
105<dl class="method">
106<dt id="sans.models.NewCylinderModel.CylinderModel.getParam">
107<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>
108<dd><p>Set the value of a model parameter</p>
109<table class="docutils field-list" frame="void" rules="none">
110<col class="field-name" />
111<col class="field-body" />
112<tbody valign="top">
113<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
114<li><strong>name</strong> &#8211; name of the parameter</li>
115<li><strong>value</strong> &#8211; value of the parameter</li>
116</ul>
117</td>
118</tr>
119</tbody>
120</table>
121</dd></dl>
122
123<dl class="method">
124<dt id="sans.models.NewCylinderModel.CylinderModel.getParamList">
125<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>
126<dd>Return a list of all available parameters for the model</dd></dl>
127
128<dl class="method">
129<dt id="sans.models.NewCylinderModel.CylinderModel.getParamListWithToken">
130<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>
131<dd></dd></dl>
132
133<dl class="method">
134<dt id="sans.models.NewCylinderModel.CylinderModel.getParamWithToken">
135<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>
136<dd></dd></dl>
137
138<dl class="attribute">
139<dt id="sans.models.NewCylinderModel.CylinderModel.log">
140<tt class="descname">log</tt><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.log" title="Permalink to this definition">¶</a></dt>
141<dd>Log</dd></dl>
142
143<dl class="attribute">
144<dt id="sans.models.NewCylinderModel.CylinderModel.params">
145<tt class="descname">params</tt><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.params" title="Permalink to this definition">¶</a></dt>
146<dd>Parameters</dd></dl>
147
148<dl class="attribute">
149<dt id="sans.models.NewCylinderModel.CylinderModel.reset">
150<tt class="descname">reset</tt><a class="headerlink" href="#sans.models.NewCylinderModel.CylinderModel.reset" title="Permalink to this definition">¶</a></dt>
151<dd>Reset pair correlation</dd></dl>
152
153<dl class="method">
154<dt id="sans.models.NewCylinderModel.CylinderModel.run">
155<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>
156<dd>Evaluate the model
157&#64;param x: input q, or [q,phi]
158&#64;return: scattering function P(q)</dd></dl>
159
160<dl class="method">
161<dt id="sans.models.NewCylinderModel.CylinderModel.runXY">
162<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>
163<dd>Evaluate the model in cartesian coordinates
164&#64;param x: input q, or [qx, qy]
165&#64;return: scattering function P(q)</dd></dl>
166
167<dl class="method">
168<dt id="sans.models.NewCylinderModel.CylinderModel.setParam">
169<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>
170<dd><p>Set the value of a model parameter</p>
171<table class="docutils field-list" frame="void" rules="none">
172<col class="field-name" />
173<col class="field-body" />
174<tbody valign="top">
175<tr class="field"><th class="field-name">Parameters:</th><td class="field-body"><ul class="first last simple">
176<li><strong>name</strong> &#8211; name of the parameter</li>
177<li><strong>value</strong> &#8211; value of the parameter</li>
178</ul>
179</td>
180</tr>
181</tbody>
182</table>
183</dd></dl>
184
185<dl class="method">
186<dt id="sans.models.NewCylinderModel.CylinderModel.setParamWithToken">
187<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>
188<dd></dd></dl>
189
190<dl class="method">
191<dt id="sans.models.NewCylinderModel.CylinderModel.set_dispersion">
192<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>
193<dd>Set the dispersion object for a model parameter
194&#64;param parameter: name of the parameter [string]
195&#64;dispersion: dispersion object of type DispersionModel</dd></dl>
196
197</dd></dl>
198
199</div>
200</div>
201
202
203          </div>
204        </div>
205      </div>
206      <div class="sphinxsidebar">
207        <div class="sphinxsidebarwrapper">
208  <h3><a href="../index.html">Table Of Contents</a></h3>
209  <ul>
210<li><a class="reference internal" href="#">NewCylinderModel</a><ul>
211<li><a class="reference internal" href="#module-sans.models.NewCylinderModel"><tt class="docutils literal"><span class="pre">sans.models.NewCylinderModel</span></tt></a></li>
212</ul>
213</li>
214</ul>
215
216  <h4>Previous topic</h4>
217  <p class="topless"><a href="MultiShellModel.html"
218                        title="previous chapter">MultiShellModel</a></p>
219  <h4>Next topic</h4>
220  <p class="topless"><a href="NoStructure.html"
221                        title="next chapter">NoStructure</a></p>
222  <h3>This Page</h3>
223  <ul class="this-page-menu">
224    <li><a href="../_sources/api/NewCylinderModel.txt"
225           rel="nofollow">Show Source</a></li>
226  </ul>
227<div id="searchbox" style="display: none">
228  <h3>Quick search</h3>
229    <form class="search" action="../search.html" method="get">
230      <input type="text" name="q" size="18" />
231      <input type="submit" value="Go" />
232      <input type="hidden" name="check_keywords" value="yes" />
233      <input type="hidden" name="area" value="default" />
234    </form>
235    <p class="searchtip" style="font-size: 90%">
236    Enter search terms or a module, class or function name.
237    </p>
238</div>
239<script type="text/javascript">$('#searchbox').show(0);</script>
240        </div>
241      </div>
242      <div class="clearer"></div>
243    </div>
244    <div class="related">
245      <h3>Navigation</h3>
246      <ul>
247        <li class="right" style="margin-right: 10px">
248          <a href="../genindex.html" title="General Index"
249             >index</a></li>
250        <li class="right" >
251          <a href="../py-modindex.html" title="Python Module Index"
252             >modules</a> |</li>
253        <li class="right" >
254          <a href="NoStructure.html" title="NoStructure"
255             >next</a> |</li>
256        <li class="right" >
257          <a href="MultiShellModel.html" title="MultiShellModel"
258             >previous</a> |</li>
259        <li><a href="../index.html">sansmodels v0.1.0 documentation</a> &raquo;</li>
260          <li><a href="index.html" >Reference</a> &raquo;</li> 
261      </ul>
262    </div>
263    <div class="footer">
264        &copy; Copyright 2010, sans group.
265      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0b1.
266    </div>
267  </body>
268</html>
Note: See TracBrowser for help on using the repository browser.