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