source: sasview/sansmodels/docs/sphinx/html/api/HollowCylinderModel.html @ 512573a

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

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